discoveryv1

package
v0.4.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 1, 2019 License: Apache-2.0 Imports: 5 Imported by: 3

Documentation

Overview

Package discoveryv1 : Operations and models for the DiscoveryV1 service

Index

Constants

View Source 
const (
	Collection_Status_Active      = "active"
	Collection_Status_Maintenance = "maintenance"
	Collection_Status_Pending     = "pending"
)

Constants associated with the Collection.Status property. The status of the collection.

View Source 
const (
	CreateCollectionOptions_Language_Ar = "ar"
	CreateCollectionOptions_Language_De = "de"
	CreateCollectionOptions_Language_En = "en"
	CreateCollectionOptions_Language_Es = "es"
	CreateCollectionOptions_Language_Fr = "fr"
	CreateCollectionOptions_Language_It = "it"
	CreateCollectionOptions_Language_Ja = "ja"
	CreateCollectionOptions_Language_Ko = "ko"
	CreateCollectionOptions_Language_Nl = "nl"
	CreateCollectionOptions_Language_Pt = "pt"
)

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.

View Source 
const (
	CreateCredentialsOptions_SourceType_Box        = "box"
	CreateCredentialsOptions_SourceType_Salesforce = "salesforce"
	CreateCredentialsOptions_SourceType_Sharepoint = "sharepoint"
	CreateCredentialsOptions_SourceType_WebCrawl   = "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.

View Source 
const (
	CreateEnvironmentOptions_Size_L    = "L"
	CreateEnvironmentOptions_Size_Lt   = "LT"
	CreateEnvironmentOptions_Size_M    = "M"
	CreateEnvironmentOptions_Size_Ml   = "ML"
	CreateEnvironmentOptions_Size_Ms   = "MS"
	CreateEnvironmentOptions_Size_S    = "S"
	CreateEnvironmentOptions_Size_Xl   = "XL"
	CreateEnvironmentOptions_Size_Xs   = "XS"
	CreateEnvironmentOptions_Size_Xxl  = "XXL"
	CreateEnvironmentOptions_Size_Xxxl = "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`.

View Source 
const (
	CredentialDetails_CredentialType_Basic            = "basic"
	CredentialDetails_CredentialType_Noauth           = "noauth"
	CredentialDetails_CredentialType_NtmlV1           = "ntml_v1"
	CredentialDetails_CredentialType_Oauth2           = "oauth2"
	CredentialDetails_CredentialType_Saml             = "saml"
	CredentialDetails_CredentialType_UsernamePassword = "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 `ntml_v1` with **source_version** of `2016` - `"source_type": "web_crawl"` - valid `credential_type`s: `noauth` or `basic`.

View Source 
const (
	CredentialDetails_SourceVersion_2016   = "2016"
	CredentialDetails_SourceVersion_Online = "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`.

View Source 
const (
	Credentials_SourceType_Box        = "box"
	Credentials_SourceType_Salesforce = "salesforce"
	Credentials_SourceType_Sharepoint = "sharepoint"
	Credentials_SourceType_WebCrawl   = "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.

View Source 
const (
	DocumentSnapshot_Step_EnrichmentsOutput        = "enrichments_output"
	DocumentSnapshot_Step_HTMLInput                = "html_input"
	DocumentSnapshot_Step_HTMLOutput               = "html_output"
	DocumentSnapshot_Step_JSONNormalizationsOutput = "json_normalizations_output"
	DocumentSnapshot_Step_JSONOutput               = "json_output"
	DocumentSnapshot_Step_NormalizationsOutput     = "normalizations_output"
)

Constants associated with the DocumentSnapshot.Step property.

View Source 
const (
	DocumentStatus_Status_Available            = "available"
	DocumentStatus_Status_AvailableWithNotices = "available with notices"
	DocumentStatus_Status_Failed               = "failed"
	DocumentStatus_Status_Processing           = "processing"
)

Constants associated with the DocumentStatus.Status property. Status of the document in the ingestion process.

View Source 
const (
	DocumentStatus_FileType_HTML = "html"
	DocumentStatus_FileType_JSON = "json"
	DocumentStatus_FileType_Pdf  = "pdf"
	DocumentStatus_FileType_Word = "word"
)

Constants associated with the DocumentStatus.FileType property. The type of the original source file.

View Source 
const (
	EnrichmentOptions_Language_Ar = "ar"
	EnrichmentOptions_Language_De = "de"
	EnrichmentOptions_Language_En = "en"
	EnrichmentOptions_Language_Es = "es"
	EnrichmentOptions_Language_Fr = "fr"
	EnrichmentOptions_Language_It = "it"
	EnrichmentOptions_Language_Pt = "pt"
	EnrichmentOptions_Language_Ru = "ru"
	EnrichmentOptions_Language_Sv = "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.

View Source 
const (
	Environment_Status_Active      = "active"
	Environment_Status_Maintenance = "maintenance"
	Environment_Status_Pending     = "pending"
	Environment_Status_Resizing    = "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.

View Source 
const (
	Environment_Size_L    = "L"
	Environment_Size_Lt   = "LT"
	Environment_Size_M    = "M"
	Environment_Size_Ml   = "ML"
	Environment_Size_Ms   = "MS"
	Environment_Size_S    = "S"
	Environment_Size_Xl   = "XL"
	Environment_Size_Xs   = "XS"
	Environment_Size_Xxl  = "XXL"
	Environment_Size_Xxxl = "XXXL"
)

Constants associated with the Environment.Size property. Current size of the environment.

View Source 
const (
	Field_FieldType_Binary  = "binary"
	Field_FieldType_Boolean = "boolean"
	Field_FieldType_Byte    = "byte"
	Field_FieldType_Date    = "date"
	Field_FieldType_Double  = "double"
	Field_FieldType_Float   = "float"
	Field_FieldType_Integer = "integer"
	Field_FieldType_Long    = "long"
	Field_FieldType_Nested  = "nested"
	Field_FieldType_Short   = "short"
	Field_FieldType_String  = "string"
)

Constants associated with the Field.FieldType property. The type of the field.

View Source 
const (
	Gateway_Status_Connected = "connected"
	Gateway_Status_Idle      = "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.

View Source 
const (
	LogQueryResponseResult_DocumentType_Event = "event"
	LogQueryResponseResult_DocumentType_Query = "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.
View Source 
const (
	LogQueryResponseResult_EventType_Click = "click"
	LogQueryResponseResult_EventType_Query = "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.

View Source 
const (
	NormalizationOperation_Operation_Copy        = "copy"
	NormalizationOperation_Operation_Merge       = "merge"
	NormalizationOperation_Operation_Move        = "move"
	NormalizationOperation_Operation_Remove      = "remove"
	NormalizationOperation_Operation_RemoveNulls = "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 JSON tree. **source_field** and **destination_field** are ignored by this operation because _remove_nulls_ operates on the entire JSON tree. Typically, **remove_nulls** is invoked as the last normalization operation (if it is invoked at all, it can be time-expensive).

View Source 
const (
	Notice_Severity_Error   = "error"
	Notice_Severity_Warning = "warning"
)

Constants associated with the Notice.Severity property. Severity level of the notice.

View Source 
const (
	QueryNoticesResult_FileType_HTML = "html"
	QueryNoticesResult_FileType_JSON = "json"
	QueryNoticesResult_FileType_Pdf  = "pdf"
	QueryNoticesResult_FileType_Word = "word"
)

Constants associated with the QueryNoticesResult.FileType property. The type of the original source file.

View Source 
const (
	QueryRelationsOptions_Sort_Frequency = "frequency"
	QueryRelationsOptions_Sort_Score     = "score"
)

Constants associated with the QueryRelationsOptions.Sort property. The sorting method for the relationships, can be `score` or `frequency`. `frequency` is the number of unique times each entity is identified. The default is `score`. This parameter cannot be used in the same query as the **bias** parameter.

View Source 
const (
	RetrievalDetails_DocumentRetrievalStrategy_ContinuousRelevancyTraining = "continuous_relevancy_training"
	RetrievalDetails_DocumentRetrievalStrategy_RelevancyTraining           = "relevancy_training"
	RetrievalDetails_DocumentRetrievalStrategy_Untrained                   = "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`.

View Source 
const (
	SearchStatus_Status_InsufficentData = "INSUFFICENT_DATA"
	SearchStatus_Status_NoData          = "NO_DATA"
	SearchStatus_Status_NotApplicable   = "NOT_APPLICABLE"
	SearchStatus_Status_Trained         = "TRAINED"
	SearchStatus_Status_Training        = "TRAINING"
)

Constants associated with the SearchStatus.Status property. The current status of Continuous Relevancy Training for this environment.

View Source 
const (
	Source_Type_Box        = "box"
	Source_Type_Salesforce = "salesforce"
	Source_Type_Sharepoint = "sharepoint"
	Source_Type_WebCrawl   = "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.

View Source 
const (
	SourceOptionsWebCrawl_CrawlSpeed_Aggressive = "aggressive"
	SourceOptionsWebCrawl_CrawlSpeed_Gentle     = "gentle"
	SourceOptionsWebCrawl_CrawlSpeed_Normal     = "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.

View Source 
const (
	SourceSchedule_Frequency_Daily   = "daily"
	SourceSchedule_Frequency_Monthly = "monthly"
	SourceSchedule_Frequency_Weekly  = "weekly"
)

Constants associated with the SourceSchedule.Frequency property. The crawl schedule in the specified **time_zone**.

- `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.

View Source 
const (
	SourceStatus_Status_Complete            = "complete"
	SourceStatus_Status_CompleteWithNotices = "complete_with_notices"
	SourceStatus_Status_NotConfigured       = "not_configured"
	SourceStatus_Status_Running             = "running"
	SourceStatus_Status_Stopped             = "stopped"
)

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. - `complete_with_notices` indicates that some notices were generated during the crawl. Notices can be checked by using the **notices** query method. - `stopped` indicates that the crawl has stopped but is not complete.

View Source 
const (
	TestConfigurationInEnvironmentOptions_Step_EnrichmentsOutput        = "enrichments_output"
	TestConfigurationInEnvironmentOptions_Step_HTMLInput                = "html_input"
	TestConfigurationInEnvironmentOptions_Step_HTMLOutput               = "html_output"
	TestConfigurationInEnvironmentOptions_Step_JSONNormalizationsOutput = "json_normalizations_output"
	TestConfigurationInEnvironmentOptions_Step_JSONOutput               = "json_output"
	TestConfigurationInEnvironmentOptions_Step_NormalizationsOutput     = "normalizations_output"
)

Constants associated with the TestConfigurationInEnvironmentOptions.Step property. Specify to only run the input document through the given step instead of running the input document through the entire ingestion workflow. Valid values are `convert`, `enrich`, and `normalize`.

View Source 
const (
	TokenDictStatusResponse_Status_Active   = "active"
	TokenDictStatusResponse_Status_NotFound = "not found"
	TokenDictStatusResponse_Status_Pending  = "pending"
)

Constants associated with the TokenDictStatusResponse.Status property. Current wordlist status for the specified collection.

View Source 
const (
	UpdateCredentialsOptions_SourceType_Box        = "box"
	UpdateCredentialsOptions_SourceType_Salesforce = "salesforce"
	UpdateCredentialsOptions_SourceType_Sharepoint = "sharepoint"
	UpdateCredentialsOptions_SourceType_WebCrawl   = "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.

View Source 
const (
	UpdateEnvironmentOptions_Size_L    = "L"
	UpdateEnvironmentOptions_Size_M    = "M"
	UpdateEnvironmentOptions_Size_Ml   = "ML"
	UpdateEnvironmentOptions_Size_Ms   = "MS"
	UpdateEnvironmentOptions_Size_S    = "S"
	UpdateEnvironmentOptions_Size_Xl   = "XL"
	UpdateEnvironmentOptions_Size_Xxl  = "XXL"
	UpdateEnvironmentOptions_Size_Xxxl = "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.

View Source 
const (
	CreateEventOptions_Type_Click = "click"
)

Constants associated with the CreateEventOptions.Type property. The event type to be created.

View Source 
const (
	CreateEventResponse_Type_Click = "click"
)

Constants associated with the CreateEventResponse.Type property. The event type that was created.

View Source 
const (
	DeleteCollectionResponse_Status_Deleted = "deleted"
)

Constants associated with the DeleteCollectionResponse.Status property. The status of the collection. The status of a successful deletion operation is `deleted`.

View Source 
const (
	DeleteConfigurationResponse_Status_Deleted = "deleted"
)

Constants associated with the DeleteConfigurationResponse.Status property. Status of the configuration. A deleted configuration has the status deleted.

View Source 
const (
	DeleteCredentials_Status_Deleted = "deleted"
)

Constants associated with the DeleteCredentials.Status property. The status of the deletion request.

View Source 
const (
	DeleteDocumentResponse_Status_Deleted = "deleted"
)

Constants associated with the DeleteDocumentResponse.Status property. Status of the document. A deleted document has the status deleted.

View Source 
const (
	DeleteEnvironmentResponse_Status_Deleted = "deleted"
)

Constants associated with the DeleteEnvironmentResponse.Status property. Status of the environment.

View Source 
const (
	DocumentAccepted_Status_Processing = "processing"
)

Constants associated with the DocumentAccepted.Status property. Status of the document in the ingestion process.

View Source 
const (
	GetMetricsEventRateOptions_ResultType_Document = "document"
)

Constants associated with the GetMetricsEventRateOptions.ResultType property. The type of result to consider when calculating the metric.

View Source 
const (
	GetMetricsQueryEventOptions_ResultType_Document = "document"
)

Constants associated with the GetMetricsQueryEventOptions.ResultType property. The type of result to consider when calculating the metric.

View Source 
const (
	GetMetricsQueryNoResultsOptions_ResultType_Document = "document"
)

Constants associated with the GetMetricsQueryNoResultsOptions.ResultType property. The type of result to consider when calculating the metric.

View Source 
const (
	GetMetricsQueryOptions_ResultType_Document = "document"
)

Constants associated with the GetMetricsQueryOptions.ResultType property. The type of result to consider when calculating the metric.

View Source 
const (
	LogQueryResponseResult_ResultType_Document = "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

This section is empty.

Types

type AddDocumentOptions 

type AddDocumentOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The content of the document to ingest. The maximum supported file size is 50 megabytes. Files larger than 50
	// megabytes is rejected.
	File *os.File `json:"file,omitempty"`

	// The filename for file.
	Filename *string `json:"filename,omitempty"`

	// If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata that
	// the Data Crawler might send. 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:"metadata,omitempty"`

	// The content type of file. Values for this parameter can be obtained from the HttpMediaType class.
	FileContentType *string `json:"file_content_type,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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 *os.File) *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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	NaturalLanguageQuery *string `json:"natural_language_query,omitempty"`

	Filter *string `json:"filter,omitempty"`

	Examples []TrainingExample `json:"examples,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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 []QueryAggregation `json:"aggregations,omitempty"`
}

AggregationResult : AggregationResult struct

type Calculation 

type Calculation struct {

	// 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

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"`

	// The object providing information about the documents in the collection. Present only when retrieving details of a
	// collection.
	DocumentCounts *DocumentCounts `json:"document_counts,omitempty"`

	// Summary of the disk usage statistics for this collection.
	DiskUsage *CollectionDiskUsage `json:"disk_usage,omitempty"`

	// Provides information about the status of relevance training for collection.
	TrainingStatus *TrainingStatus `json:"training_status,omitempty"`

	// Object containing source crawl status information.
	SourceCrawl *SourceStatus `json:"source_crawl,omitempty"`
}

Collection : A collection for storing documents.

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 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,omitempty"`

	// 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"`
}

Conversions : Document conversion settings.

type CreateCollectionOptions 

type CreateCollectionOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// 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 to be GDPR compliant
	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:"environment_id" validate:"required"`

	// The name of the configuration.
	Name *string `json:"name,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"`

	// Allows users to set headers to be GDPR compliant
	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:"environment_id" validate:"required"`

	// 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.
	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"`

	// Allows users to set headers to be GDPR compliant
	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

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 to be GDPR compliant
	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 to be GDPR compliant
	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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// 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,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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 added in v0.3.0 

type CreateGatewayOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// User-defined name.
	Name *string `json:"name,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

CreateGatewayOptions : The createGateway options.

func (*CreateGatewayOptions) SetEnvironmentID added in v0.3.0 

func (options *CreateGatewayOptions) SetEnvironmentID(environmentID string) *CreateGatewayOptions

SetEnvironmentID : Allow user to set EnvironmentID

func (*CreateGatewayOptions) SetHeaders added in v0.3.0 

func (options *CreateGatewayOptions) SetHeaders(param map[string]string) *CreateGatewayOptions

SetHeaders : Allow user to set Headers

func (*CreateGatewayOptions) SetName added in v0.3.0 

func (options *CreateGatewayOptions) SetName(name string) *CreateGatewayOptions

SetName : Allow user to set Name

type CreateStopwordListOptions added in v0.3.0 

type CreateStopwordListOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The content of the stopword list to ingest.
	StopwordFile *os.File `json:"stopword_file" validate:"required"`

	// The filename for stopwordFile.
	StopwordFilename *string `json:"stopword_filename" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

CreateStopwordListOptions : The createStopwordList options.

func (*CreateStopwordListOptions) SetCollectionID added in v0.3.0 

func (options *CreateStopwordListOptions) SetCollectionID(collectionID string) *CreateStopwordListOptions

SetCollectionID : Allow user to set CollectionID

func (*CreateStopwordListOptions) SetEnvironmentID added in v0.3.0 

func (options *CreateStopwordListOptions) SetEnvironmentID(environmentID string) *CreateStopwordListOptions

SetEnvironmentID : Allow user to set EnvironmentID

func (*CreateStopwordListOptions) SetHeaders added in v0.3.0 

func (options *CreateStopwordListOptions) SetHeaders(param map[string]string) *CreateStopwordListOptions

SetHeaders : Allow user to set Headers

func (*CreateStopwordListOptions) SetStopwordFile added in v0.3.0 

func (options *CreateStopwordListOptions) SetStopwordFile(stopwordFile *os.File) *CreateStopwordListOptions

SetStopwordFile : Allow user to set StopwordFile

func (*CreateStopwordListOptions) SetStopwordFilename added in v0.3.0 

func (options *CreateStopwordListOptions) SetStopwordFilename(stopwordFilename string) *CreateStopwordListOptions

SetStopwordFilename : Allow user to set StopwordFilename

type CreateTokenizationDictionaryOptions added in v0.1.0 

type CreateTokenizationDictionaryOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// 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 to be GDPR compliant
	Headers map[string]string
}

CreateTokenizationDictionaryOptions : The createTokenizationDictionary options.

func (*CreateTokenizationDictionaryOptions) SetCollectionID added in v0.1.0 

func (options *CreateTokenizationDictionaryOptions) SetCollectionID(collectionID string) *CreateTokenizationDictionaryOptions

SetCollectionID : Allow user to set CollectionID

func (*CreateTokenizationDictionaryOptions) SetEnvironmentID added in v0.1.0 

func (options *CreateTokenizationDictionaryOptions) SetEnvironmentID(environmentID string) *CreateTokenizationDictionaryOptions

SetEnvironmentID : Allow user to set EnvironmentID

func (*CreateTokenizationDictionaryOptions) SetHeaders added in v0.1.0 

func (options *CreateTokenizationDictionaryOptions) SetHeaders(param map[string]string) *CreateTokenizationDictionaryOptions

SetHeaders : Allow user to set Headers

func (*CreateTokenizationDictionaryOptions) SetTokenizationRules added in v0.1.0 

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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The ID of the query used for training.
	QueryID *string `json:"query_id" validate:"required"`

	DocumentID *string `json:"document_id,omitempty"`

	CrossReference *string `json:"cross_reference,omitempty"`

	Relevance *int64 `json:"relevance,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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
	// `ntml_v1` with **source_version** of `2016`
	// -  `"source_type": "web_crawl"` - valid `credential_type`s: `noauth` or `basic`.
	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 `ntml_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 `ntml_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 `ntml_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`.
	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"`
}

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.
	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"`
}

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 : CredentialsList struct

type DeleteAllTrainingDataOptions 

type DeleteAllTrainingDataOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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 : DeleteCollectionResponse struct

type DeleteConfigurationOptions 

type DeleteConfigurationOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the configuration.
	ConfigurationID *string `json:"configuration_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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 : DeleteConfigurationResponse struct

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:"environment_id" validate:"required"`

	// The unique identifier for a set of source credentials.
	CredentialID *string `json:"credential_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The ID of the document.
	DocumentID *string `json:"document_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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 : DeleteDocumentResponse struct

type DeleteEnvironmentOptions 

type DeleteEnvironmentOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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 : DeleteEnvironmentResponse struct

type DeleteExpansionsOptions 

type DeleteExpansionsOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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 added in v0.3.0 

type DeleteGatewayOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The requested gateway ID.
	GatewayID *string `json:"gateway_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

DeleteGatewayOptions : The deleteGateway options.

func (*DeleteGatewayOptions) SetEnvironmentID added in v0.3.0 

func (options *DeleteGatewayOptions) SetEnvironmentID(environmentID string) *DeleteGatewayOptions

SetEnvironmentID : Allow user to set EnvironmentID

func (*DeleteGatewayOptions) SetGatewayID added in v0.3.0 

func (options *DeleteGatewayOptions) SetGatewayID(gatewayID string) *DeleteGatewayOptions

SetGatewayID : Allow user to set GatewayID

func (*DeleteGatewayOptions) SetHeaders added in v0.3.0 

func (options *DeleteGatewayOptions) SetHeaders(param map[string]string) *DeleteGatewayOptions

SetHeaders : Allow user to set Headers

type DeleteStopwordListOptions added in v0.3.0 

type DeleteStopwordListOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

DeleteStopwordListOptions : The deleteStopwordList options.

func (*DeleteStopwordListOptions) SetCollectionID added in v0.3.0 

func (options *DeleteStopwordListOptions) SetCollectionID(collectionID string) *DeleteStopwordListOptions

SetCollectionID : Allow user to set CollectionID

func (*DeleteStopwordListOptions) SetEnvironmentID added in v0.3.0 

func (options *DeleteStopwordListOptions) SetEnvironmentID(environmentID string) *DeleteStopwordListOptions

SetEnvironmentID : Allow user to set EnvironmentID

func (*DeleteStopwordListOptions) SetHeaders added in v0.3.0 

func (options *DeleteStopwordListOptions) SetHeaders(param map[string]string) *DeleteStopwordListOptions

SetHeaders : Allow user to set Headers

type DeleteTokenizationDictionaryOptions added in v0.1.0 

type DeleteTokenizationDictionaryOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

DeleteTokenizationDictionaryOptions : The deleteTokenizationDictionary options.

func (*DeleteTokenizationDictionaryOptions) SetCollectionID added in v0.1.0 

func (options *DeleteTokenizationDictionaryOptions) SetCollectionID(collectionID string) *DeleteTokenizationDictionaryOptions

SetCollectionID : Allow user to set CollectionID

func (*DeleteTokenizationDictionaryOptions) SetEnvironmentID added in v0.1.0 

func (options *DeleteTokenizationDictionaryOptions) SetEnvironmentID(environmentID string) *DeleteTokenizationDictionaryOptions

SetEnvironmentID : Allow user to set EnvironmentID

func (*DeleteTokenizationDictionaryOptions) SetHeaders added in v0.1.0 

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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The ID of the query used for training.
	QueryID *string `json:"query_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The ID of the query used for training.
	QueryID *string `json:"query_id" validate:"required"`

	// The ID of the document as it is indexed.
	ExampleID *string `json:"example_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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:"customer_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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.WatsonService
}

DiscoveryV1 : The IBM Watson™ Discovery Service 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.

Version: V1 See: http://www.ibm.com/watson/developercloud/discovery.html

func NewDiscoveryV1 

func NewDiscoveryV1(options *DiscoveryV1Options) (*DiscoveryV1, error)

NewDiscoveryV1 : Instantiate DiscoveryV1

func (*DiscoveryV1) AddDocument 

func (discovery *DiscoveryV1) AddDocument(addDocumentOptions *AddDocumentOptions) (*core.DetailedResponse, 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 `,`.

func (*DiscoveryV1) AddTrainingData 

func (discovery *DiscoveryV1) AddTrainingData(addTrainingDataOptions *AddTrainingDataOptions) (*core.DetailedResponse, 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) CreateCollection 

func (discovery *DiscoveryV1) CreateCollection(createCollectionOptions *CreateCollectionOptions) (*core.DetailedResponse, error)

CreateCollection : Create a collection

func (*DiscoveryV1) CreateConfiguration 

func (discovery *DiscoveryV1) CreateConfiguration(createConfigurationOptions *CreateConfigurationOptions) (*core.DetailedResponse, 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) CreateCredentials 

func (discovery *DiscoveryV1) CreateCredentials(createCredentialsOptions *CreateCredentialsOptions) (*core.DetailedResponse, 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) CreateEnvironment 

func (discovery *DiscoveryV1) CreateEnvironment(createEnvironmentOptions *CreateEnvironmentOptions) (*core.DetailedResponse, 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) CreateEvent 

func (discovery *DiscoveryV1) CreateEvent(createEventOptions *CreateEventOptions) (*core.DetailedResponse, 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 occured.

func (*DiscoveryV1) CreateExpansions 

func (discovery *DiscoveryV1) CreateExpansions(createExpansionsOptions *CreateExpansionsOptions) (*core.DetailedResponse, 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) CreateGateway added in v0.3.0 

func (discovery *DiscoveryV1) CreateGateway(createGatewayOptions *CreateGatewayOptions) (*core.DetailedResponse, error)

CreateGateway : Create Gateway Create a gateway configuration to use with a remotely installed gateway.

func (*DiscoveryV1) CreateStopwordList added in v0.3.0 

func (discovery *DiscoveryV1) CreateStopwordList(createStopwordListOptions *CreateStopwordListOptions) (*core.DetailedResponse, error)

CreateStopwordList : Create stopword list Upload a custom stopword list to use with the specified collection.

func (*DiscoveryV1) CreateTokenizationDictionary added in v0.1.0 

func (discovery *DiscoveryV1) CreateTokenizationDictionary(createTokenizationDictionaryOptions *CreateTokenizationDictionaryOptions) (*core.DetailedResponse, error)

CreateTokenizationDictionary : Create tokenization dictionary Upload a custom tokenization dictionary to use with the specified collection.

func (*DiscoveryV1) CreateTrainingExample 

func (discovery *DiscoveryV1) CreateTrainingExample(createTrainingExampleOptions *CreateTrainingExampleOptions) (*core.DetailedResponse, error)

CreateTrainingExample : Add example to training data query Adds a example to this training data query.

func (*DiscoveryV1) DeleteAllTrainingData 

func (discovery *DiscoveryV1) DeleteAllTrainingData(deleteAllTrainingDataOptions *DeleteAllTrainingDataOptions) (*core.DetailedResponse, error)

DeleteAllTrainingData : Delete all training data Deletes all training data from a collection.

func (*DiscoveryV1) DeleteCollection 

func (discovery *DiscoveryV1) DeleteCollection(deleteCollectionOptions *DeleteCollectionOptions) (*core.DetailedResponse, error)

DeleteCollection : Delete a collection

func (*DiscoveryV1) DeleteConfiguration 

func (discovery *DiscoveryV1) DeleteConfiguration(deleteConfigurationOptions *DeleteConfigurationOptions) (*core.DetailedResponse, 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) DeleteCredentials 

func (discovery *DiscoveryV1) DeleteCredentials(deleteCredentialsOptions *DeleteCredentialsOptions) (*core.DetailedResponse, error)

DeleteCredentials : Delete credentials Deletes a set of stored credentials from your Discovery instance.

func (*DiscoveryV1) DeleteDocument 

func (discovery *DiscoveryV1) DeleteDocument(deleteDocumentOptions *DeleteDocumentOptions) (*core.DetailedResponse, 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) DeleteEnvironment 

func (discovery *DiscoveryV1) DeleteEnvironment(deleteEnvironmentOptions *DeleteEnvironmentOptions) (*core.DetailedResponse, error)

DeleteEnvironment : Delete environment

func (*DiscoveryV1) DeleteExpansions 

func (discovery *DiscoveryV1) DeleteExpansions(deleteExpansionsOptions *DeleteExpansionsOptions) (*core.DetailedResponse, 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) DeleteGateway added in v0.3.0 

func (discovery *DiscoveryV1) DeleteGateway(deleteGatewayOptions *DeleteGatewayOptions) (*core.DetailedResponse, error)

DeleteGateway : Delete Gateway Delete the specified gateway configuration.

func (*DiscoveryV1) DeleteStopwordList added in v0.3.0 

func (discovery *DiscoveryV1) DeleteStopwordList(deleteStopwordListOptions *DeleteStopwordListOptions) (*core.DetailedResponse, 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) DeleteTokenizationDictionary added in v0.1.0 

func (discovery *DiscoveryV1) DeleteTokenizationDictionary(deleteTokenizationDictionaryOptions *DeleteTokenizationDictionaryOptions) (*core.DetailedResponse, error)

DeleteTokenizationDictionary : Delete tokenization dictionary Delete the tokenization dictionary from the collection.

func (*DiscoveryV1) DeleteTrainingData 

func (discovery *DiscoveryV1) DeleteTrainingData(deleteTrainingDataOptions *DeleteTrainingDataOptions) (*core.DetailedResponse, error)

DeleteTrainingData : Delete a training data query Removes the training data query and all associated examples from the training data set.

func (*DiscoveryV1) DeleteTrainingExample 

func (discovery *DiscoveryV1) DeleteTrainingExample(deleteTrainingExampleOptions *DeleteTrainingExampleOptions) (*core.DetailedResponse, error)

DeleteTrainingExample : Delete example for training data query Deletes the example document with the given ID from the training data query.

func (*DiscoveryV1) DeleteUserData 

func (discovery *DiscoveryV1) DeleteUserData(deleteUserDataOptions *DeleteUserDataOptions) (*core.DetailedResponse, 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://console.bluemix.net/docs/services/discovery/information-security.html).

func (*DiscoveryV1) FederatedQuery 

func (discovery *DiscoveryV1) FederatedQuery(federatedQueryOptions *FederatedQueryOptions) (*core.DetailedResponse, error)

FederatedQuery : Long environment queries Complex queries might be too long for a standard method query. By using this method, you can construct longer queries. However, these queries may take longer to complete than the standard method. For details, see the [Discovery service documentation](https://console.bluemix.net/docs/services/discovery/using.html).

func (*DiscoveryV1) FederatedQueryNotices 

func (discovery *DiscoveryV1) FederatedQueryNotices(federatedQueryNoticesOptions *FederatedQueryNoticesOptions) (*core.DetailedResponse, 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 service documentation](https://console.bluemix.net/docs/services/discovery/using.html) for more details on the query language.

func (*DiscoveryV1) GetAddDocumentResult 

func (discovery *DiscoveryV1) GetAddDocumentResult(response *core.DetailedResponse) *DocumentAccepted

GetAddDocumentResult : Retrieve result of AddDocument operation

func (*DiscoveryV1) GetAddTrainingDataResult 

func (discovery *DiscoveryV1) GetAddTrainingDataResult(response *core.DetailedResponse) *TrainingQuery

GetAddTrainingDataResult : Retrieve result of AddTrainingData operation

func (*DiscoveryV1) GetCollection 

func (discovery *DiscoveryV1) GetCollection(getCollectionOptions *GetCollectionOptions) (*core.DetailedResponse, error)

GetCollection : Get collection details

func (*DiscoveryV1) GetConfiguration 

func (discovery *DiscoveryV1) GetConfiguration(getConfigurationOptions *GetConfigurationOptions) (*core.DetailedResponse, error)

GetConfiguration : Get configuration details

func (*DiscoveryV1) GetCreateCollectionResult 

func (discovery *DiscoveryV1) GetCreateCollectionResult(response *core.DetailedResponse) *Collection

GetCreateCollectionResult : Retrieve result of CreateCollection operation

func (*DiscoveryV1) GetCreateConfigurationResult 

func (discovery *DiscoveryV1) GetCreateConfigurationResult(response *core.DetailedResponse) *Configuration

GetCreateConfigurationResult : Retrieve result of CreateConfiguration operation

func (*DiscoveryV1) GetCreateCredentialsResult 

func (discovery *DiscoveryV1) GetCreateCredentialsResult(response *core.DetailedResponse) *Credentials

GetCreateCredentialsResult : Retrieve result of CreateCredentials operation

func (*DiscoveryV1) GetCreateEnvironmentResult 

func (discovery *DiscoveryV1) GetCreateEnvironmentResult(response *core.DetailedResponse) *Environment

GetCreateEnvironmentResult : Retrieve result of CreateEnvironment operation

func (*DiscoveryV1) GetCreateEventResult 

func (discovery *DiscoveryV1) GetCreateEventResult(response *core.DetailedResponse) *CreateEventResponse

GetCreateEventResult : Retrieve result of CreateEvent operation

func (*DiscoveryV1) GetCreateExpansionsResult 

func (discovery *DiscoveryV1) GetCreateExpansionsResult(response *core.DetailedResponse) *Expansions

GetCreateExpansionsResult : Retrieve result of CreateExpansions operation

func (*DiscoveryV1) GetCreateGatewayResult added in v0.3.0 

func (discovery *DiscoveryV1) GetCreateGatewayResult(response *core.DetailedResponse) *Gateway

GetCreateGatewayResult : Retrieve result of CreateGateway operation

func (*DiscoveryV1) GetCreateStopwordListResult added in v0.3.0 

func (discovery *DiscoveryV1) GetCreateStopwordListResult(response *core.DetailedResponse) *TokenDictStatusResponse

GetCreateStopwordListResult : Retrieve result of CreateStopwordList operation

func (*DiscoveryV1) GetCreateTokenizationDictionaryResult added in v0.1.0 

func (discovery *DiscoveryV1) GetCreateTokenizationDictionaryResult(response *core.DetailedResponse) *TokenDictStatusResponse

GetCreateTokenizationDictionaryResult : Retrieve result of CreateTokenizationDictionary operation

func (*DiscoveryV1) GetCreateTrainingExampleResult 

func (discovery *DiscoveryV1) GetCreateTrainingExampleResult(response *core.DetailedResponse) *TrainingExample

GetCreateTrainingExampleResult : Retrieve result of CreateTrainingExample operation

func (*DiscoveryV1) GetCredentials 

func (discovery *DiscoveryV1) GetCredentials(getCredentialsOptions *GetCredentialsOptions) (*core.DetailedResponse, 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) GetDeleteCollectionResult 

func (discovery *DiscoveryV1) GetDeleteCollectionResult(response *core.DetailedResponse) *DeleteCollectionResponse

GetDeleteCollectionResult : Retrieve result of DeleteCollection operation

func (*DiscoveryV1) GetDeleteConfigurationResult 

func (discovery *DiscoveryV1) GetDeleteConfigurationResult(response *core.DetailedResponse) *DeleteConfigurationResponse

GetDeleteConfigurationResult : Retrieve result of DeleteConfiguration operation

func (*DiscoveryV1) GetDeleteCredentialsResult 

func (discovery *DiscoveryV1) GetDeleteCredentialsResult(response *core.DetailedResponse) *DeleteCredentials

GetDeleteCredentialsResult : Retrieve result of DeleteCredentials operation

func (*DiscoveryV1) GetDeleteDocumentResult 

func (discovery *DiscoveryV1) GetDeleteDocumentResult(response *core.DetailedResponse) *DeleteDocumentResponse

GetDeleteDocumentResult : Retrieve result of DeleteDocument operation

func (*DiscoveryV1) GetDeleteEnvironmentResult 

func (discovery *DiscoveryV1) GetDeleteEnvironmentResult(response *core.DetailedResponse) *DeleteEnvironmentResponse

GetDeleteEnvironmentResult : Retrieve result of DeleteEnvironment operation

func (*DiscoveryV1) GetDeleteGatewayResult added in v0.3.0 

func (discovery *DiscoveryV1) GetDeleteGatewayResult(response *core.DetailedResponse) *GatewayDelete

GetDeleteGatewayResult : Retrieve result of DeleteGateway operation

func (*DiscoveryV1) GetDocumentStatus 

func (discovery *DiscoveryV1) GetDocumentStatus(getDocumentStatusOptions *GetDocumentStatusOptions) (*core.DetailedResponse, 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) GetEnvironment 

func (discovery *DiscoveryV1) GetEnvironment(getEnvironmentOptions *GetEnvironmentOptions) (*core.DetailedResponse, error)

GetEnvironment : Get environment info

func (*DiscoveryV1) GetFederatedQueryNoticesResult 

func (discovery *DiscoveryV1) GetFederatedQueryNoticesResult(response *core.DetailedResponse) *QueryNoticesResponse

GetFederatedQueryNoticesResult : Retrieve result of FederatedQueryNotices operation

func (*DiscoveryV1) GetFederatedQueryResult 

func (discovery *DiscoveryV1) GetFederatedQueryResult(response *core.DetailedResponse) *QueryResponse

GetFederatedQueryResult : Retrieve result of FederatedQuery operation

func (*DiscoveryV1) GetGateway added in v0.3.0 

func (discovery *DiscoveryV1) GetGateway(getGatewayOptions *GetGatewayOptions) (*core.DetailedResponse, error)

GetGateway : List Gateway Details List information about the specified gateway.

func (*DiscoveryV1) GetGetCollectionResult 

func (discovery *DiscoveryV1) GetGetCollectionResult(response *core.DetailedResponse) *Collection

GetGetCollectionResult : Retrieve result of GetCollection operation

func (*DiscoveryV1) GetGetConfigurationResult 

func (discovery *DiscoveryV1) GetGetConfigurationResult(response *core.DetailedResponse) *Configuration

GetGetConfigurationResult : Retrieve result of GetConfiguration operation

func (*DiscoveryV1) GetGetCredentialsResult 

func (discovery *DiscoveryV1) GetGetCredentialsResult(response *core.DetailedResponse) *Credentials

GetGetCredentialsResult : Retrieve result of GetCredentials operation

func (*DiscoveryV1) GetGetDocumentStatusResult 

func (discovery *DiscoveryV1) GetGetDocumentStatusResult(response *core.DetailedResponse) *DocumentStatus

GetGetDocumentStatusResult : Retrieve result of GetDocumentStatus operation

func (*DiscoveryV1) GetGetEnvironmentResult 

func (discovery *DiscoveryV1) GetGetEnvironmentResult(response *core.DetailedResponse) *Environment

GetGetEnvironmentResult : Retrieve result of GetEnvironment operation

func (*DiscoveryV1) GetGetGatewayResult added in v0.3.0 

func (discovery *DiscoveryV1) GetGetGatewayResult(response *core.DetailedResponse) *Gateway

GetGetGatewayResult : Retrieve result of GetGateway operation

func (*DiscoveryV1) GetGetMetricsEventRateResult 

func (discovery *DiscoveryV1) GetGetMetricsEventRateResult(response *core.DetailedResponse) *MetricResponse

GetGetMetricsEventRateResult : Retrieve result of GetMetricsEventRate operation

func (*DiscoveryV1) GetGetMetricsQueryEventResult 

func (discovery *DiscoveryV1) GetGetMetricsQueryEventResult(response *core.DetailedResponse) *MetricResponse

GetGetMetricsQueryEventResult : Retrieve result of GetMetricsQueryEvent operation

func (*DiscoveryV1) GetGetMetricsQueryNoResultsResult 

func (discovery *DiscoveryV1) GetGetMetricsQueryNoResultsResult(response *core.DetailedResponse) *MetricResponse

GetGetMetricsQueryNoResultsResult : Retrieve result of GetMetricsQueryNoResults operation

func (*DiscoveryV1) GetGetMetricsQueryResult 

func (discovery *DiscoveryV1) GetGetMetricsQueryResult(response *core.DetailedResponse) *MetricResponse

GetGetMetricsQueryResult : Retrieve result of GetMetricsQuery operation

func (*DiscoveryV1) GetGetMetricsQueryTokenEventResult 

func (discovery *DiscoveryV1) GetGetMetricsQueryTokenEventResult(response *core.DetailedResponse) *MetricTokenResponse

GetGetMetricsQueryTokenEventResult : Retrieve result of GetMetricsQueryTokenEvent operation

func (*DiscoveryV1) GetGetTokenizationDictionaryStatusResult added in v0.1.0 

func (discovery *DiscoveryV1) GetGetTokenizationDictionaryStatusResult(response *core.DetailedResponse) *TokenDictStatusResponse

GetGetTokenizationDictionaryStatusResult : Retrieve result of GetTokenizationDictionaryStatus operation

func (*DiscoveryV1) GetGetTrainingDataResult 

func (discovery *DiscoveryV1) GetGetTrainingDataResult(response *core.DetailedResponse) *TrainingQuery

GetGetTrainingDataResult : Retrieve result of GetTrainingData operation

func (*DiscoveryV1) GetGetTrainingExampleResult 

func (discovery *DiscoveryV1) GetGetTrainingExampleResult(response *core.DetailedResponse) *TrainingExample

GetGetTrainingExampleResult : Retrieve result of GetTrainingExample operation

func (*DiscoveryV1) GetListCollectionFieldsResult 

func (discovery *DiscoveryV1) GetListCollectionFieldsResult(response *core.DetailedResponse) *ListCollectionFieldsResponse

GetListCollectionFieldsResult : Retrieve result of ListCollectionFields operation

func (*DiscoveryV1) GetListCollectionsResult 

func (discovery *DiscoveryV1) GetListCollectionsResult(response *core.DetailedResponse) *ListCollectionsResponse

GetListCollectionsResult : Retrieve result of ListCollections operation

func (*DiscoveryV1) GetListConfigurationsResult 

func (discovery *DiscoveryV1) GetListConfigurationsResult(response *core.DetailedResponse) *ListConfigurationsResponse

GetListConfigurationsResult : Retrieve result of ListConfigurations operation

func (*DiscoveryV1) GetListCredentialsResult 

func (discovery *DiscoveryV1) GetListCredentialsResult(response *core.DetailedResponse) *CredentialsList

GetListCredentialsResult : Retrieve result of ListCredentials operation

func (*DiscoveryV1) GetListEnvironmentsResult 

func (discovery *DiscoveryV1) GetListEnvironmentsResult(response *core.DetailedResponse) *ListEnvironmentsResponse

GetListEnvironmentsResult : Retrieve result of ListEnvironments operation

func (*DiscoveryV1) GetListExpansionsResult 

func (discovery *DiscoveryV1) GetListExpansionsResult(response *core.DetailedResponse) *Expansions

GetListExpansionsResult : Retrieve result of ListExpansions operation

func (*DiscoveryV1) GetListFieldsResult 

func (discovery *DiscoveryV1) GetListFieldsResult(response *core.DetailedResponse) *ListCollectionFieldsResponse

GetListFieldsResult : Retrieve result of ListFields operation

func (*DiscoveryV1) GetListGatewaysResult added in v0.3.0 

func (discovery *DiscoveryV1) GetListGatewaysResult(response *core.DetailedResponse) *GatewayList

GetListGatewaysResult : Retrieve result of ListGateways operation

func (*DiscoveryV1) GetListTrainingDataResult 

func (discovery *DiscoveryV1) GetListTrainingDataResult(response *core.DetailedResponse) *TrainingDataSet

GetListTrainingDataResult : Retrieve result of ListTrainingData operation

func (*DiscoveryV1) GetListTrainingExamplesResult 

func (discovery *DiscoveryV1) GetListTrainingExamplesResult(response *core.DetailedResponse) *TrainingExampleList

GetListTrainingExamplesResult : Retrieve result of ListTrainingExamples operation

func (*DiscoveryV1) GetMetricsEventRate 

func (discovery *DiscoveryV1) GetMetricsEventRate(getMetricsEventRateOptions *GetMetricsEventRateOptions) (*core.DetailedResponse, 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) GetMetricsQuery 

func (discovery *DiscoveryV1) GetMetricsQuery(getMetricsQueryOptions *GetMetricsQueryOptions) (*core.DetailedResponse, 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) (*core.DetailedResponse, 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) GetMetricsQueryNoResults 

func (discovery *DiscoveryV1) GetMetricsQueryNoResults(getMetricsQueryNoResultsOptions *GetMetricsQueryNoResultsOptions) (*core.DetailedResponse, 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) GetMetricsQueryTokenEvent 

func (discovery *DiscoveryV1) GetMetricsQueryTokenEvent(getMetricsQueryTokenEventOptions *GetMetricsQueryTokenEventOptions) (*core.DetailedResponse, 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) GetQueryEntitiesResult 

func (discovery *DiscoveryV1) GetQueryEntitiesResult(response *core.DetailedResponse) *QueryEntitiesResponse

GetQueryEntitiesResult : Retrieve result of QueryEntities operation

func (*DiscoveryV1) GetQueryLogResult 

func (discovery *DiscoveryV1) GetQueryLogResult(response *core.DetailedResponse) *LogQueryResponse

GetQueryLogResult : Retrieve result of QueryLog operation

func (*DiscoveryV1) GetQueryNoticesResult 

func (discovery *DiscoveryV1) GetQueryNoticesResult(response *core.DetailedResponse) *QueryNoticesResponse

GetQueryNoticesResult : Retrieve result of QueryNotices operation

func (*DiscoveryV1) GetQueryRelationsResult 

func (discovery *DiscoveryV1) GetQueryRelationsResult(response *core.DetailedResponse) *QueryRelationsResponse

GetQueryRelationsResult : Retrieve result of QueryRelations operation

func (*DiscoveryV1) GetQueryResult 

func (discovery *DiscoveryV1) GetQueryResult(response *core.DetailedResponse) *QueryResponse

GetQueryResult : Retrieve result of Query operation

func (*DiscoveryV1) GetTestConfigurationInEnvironmentResult 

func (discovery *DiscoveryV1) GetTestConfigurationInEnvironmentResult(response *core.DetailedResponse) *TestDocument

GetTestConfigurationInEnvironmentResult : Retrieve result of TestConfigurationInEnvironment operation

func (*DiscoveryV1) GetTokenizationDictionaryStatus added in v0.1.0 

func (discovery *DiscoveryV1) GetTokenizationDictionaryStatus(getTokenizationDictionaryStatusOptions *GetTokenizationDictionaryStatusOptions) (*core.DetailedResponse, error)

GetTokenizationDictionaryStatus : Get tokenization dictionary status Returns the current status of the tokenization dictionary for the specified collection.

func (*DiscoveryV1) GetTrainingData 

func (discovery *DiscoveryV1) GetTrainingData(getTrainingDataOptions *GetTrainingDataOptions) (*core.DetailedResponse, error)

GetTrainingData : Get details about a query Gets details for a specific training data query, including the query string and all examples.

func (*DiscoveryV1) GetTrainingExample 

func (discovery *DiscoveryV1) GetTrainingExample(getTrainingExampleOptions *GetTrainingExampleOptions) (*core.DetailedResponse, error)

GetTrainingExample : Get details for training data example Gets the details for this training example.

func (*DiscoveryV1) GetUpdateCollectionResult 

func (discovery *DiscoveryV1) GetUpdateCollectionResult(response *core.DetailedResponse) *Collection

GetUpdateCollectionResult : Retrieve result of UpdateCollection operation

func (*DiscoveryV1) GetUpdateConfigurationResult 

func (discovery *DiscoveryV1) GetUpdateConfigurationResult(response *core.DetailedResponse) *Configuration

GetUpdateConfigurationResult : Retrieve result of UpdateConfiguration operation

func (*DiscoveryV1) GetUpdateCredentialsResult 

func (discovery *DiscoveryV1) GetUpdateCredentialsResult(response *core.DetailedResponse) *Credentials

GetUpdateCredentialsResult : Retrieve result of UpdateCredentials operation

func (*DiscoveryV1) GetUpdateDocumentResult 

func (discovery *DiscoveryV1) GetUpdateDocumentResult(response *core.DetailedResponse) *DocumentAccepted

GetUpdateDocumentResult : Retrieve result of UpdateDocument operation

func (*DiscoveryV1) GetUpdateEnvironmentResult 

func (discovery *DiscoveryV1) GetUpdateEnvironmentResult(response *core.DetailedResponse) *Environment

GetUpdateEnvironmentResult : Retrieve result of UpdateEnvironment operation

func (*DiscoveryV1) GetUpdateTrainingExampleResult 

func (discovery *DiscoveryV1) GetUpdateTrainingExampleResult(response *core.DetailedResponse) *TrainingExample

GetUpdateTrainingExampleResult : Retrieve result of UpdateTrainingExample operation

func (*DiscoveryV1) ListCollectionFields 

func (discovery *DiscoveryV1) ListCollectionFields(listCollectionFieldsOptions *ListCollectionFieldsOptions) (*core.DetailedResponse, error)

ListCollectionFields : List collection fields Gets a list of the unique fields (and their types) stored in the index.

func (*DiscoveryV1) ListCollections 

func (discovery *DiscoveryV1) ListCollections(listCollectionsOptions *ListCollectionsOptions) (*core.DetailedResponse, error)

ListCollections : List collections Lists existing collections for the service instance.

func (*DiscoveryV1) ListConfigurations 

func (discovery *DiscoveryV1) ListConfigurations(listConfigurationsOptions *ListConfigurationsOptions) (*core.DetailedResponse, error)

ListConfigurations : List configurations Lists existing configurations for the service instance.

func (*DiscoveryV1) ListCredentials 

func (discovery *DiscoveryV1) ListCredentials(listCredentialsOptions *ListCredentialsOptions) (*core.DetailedResponse, 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) ListEnvironments 

func (discovery *DiscoveryV1) ListEnvironments(listEnvironmentsOptions *ListEnvironmentsOptions) (*core.DetailedResponse, error)

ListEnvironments : List environments List existing environments for the service instance.

func (*DiscoveryV1) ListExpansions 

func (discovery *DiscoveryV1) ListExpansions(listExpansionsOptions *ListExpansionsOptions) (*core.DetailedResponse, 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) ListFields 

func (discovery *DiscoveryV1) ListFields(listFieldsOptions *ListFieldsOptions) (*core.DetailedResponse, 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) ListGateways added in v0.3.0 

func (discovery *DiscoveryV1) ListGateways(listGatewaysOptions *ListGatewaysOptions) (*core.DetailedResponse, error)

ListGateways : List Gateways List the currently configured gateways.

func (*DiscoveryV1) ListTrainingData 

func (discovery *DiscoveryV1) ListTrainingData(listTrainingDataOptions *ListTrainingDataOptions) (*core.DetailedResponse, error)

ListTrainingData : List training data Lists the training data for the specified collection.

func (*DiscoveryV1) ListTrainingExamples 

func (discovery *DiscoveryV1) ListTrainingExamples(listTrainingExamplesOptions *ListTrainingExamplesOptions) (*core.DetailedResponse, error)

ListTrainingExamples : List examples for a training data query List all examples for this training data query.

func (*DiscoveryV1) NewAddDocumentOptions 

func (discovery *DiscoveryV1) NewAddDocumentOptions(environmentID string, collectionID string) *AddDocumentOptions

NewAddDocumentOptions : Instantiate AddDocumentOptions

func (*DiscoveryV1) NewAddTrainingDataOptions 

func (discovery *DiscoveryV1) NewAddTrainingDataOptions(environmentID string, collectionID string) *AddTrainingDataOptions

NewAddTrainingDataOptions : Instantiate AddTrainingDataOptions

func (*DiscoveryV1) NewCreateCollectionOptions 

func (discovery *DiscoveryV1) NewCreateCollectionOptions(environmentID string, name string) *CreateCollectionOptions

NewCreateCollectionOptions : Instantiate CreateCollectionOptions

func (*DiscoveryV1) NewCreateConfigurationOptions 

func (discovery *DiscoveryV1) NewCreateConfigurationOptions(environmentID string) *CreateConfigurationOptions

NewCreateConfigurationOptions : Instantiate CreateConfigurationOptions

func (*DiscoveryV1) NewCreateCredentialsOptions 

func (discovery *DiscoveryV1) NewCreateCredentialsOptions(environmentID string) *CreateCredentialsOptions

NewCreateCredentialsOptions : Instantiate CreateCredentialsOptions

func (*DiscoveryV1) NewCreateEnvironmentOptions 

func (discovery *DiscoveryV1) NewCreateEnvironmentOptions(name string) *CreateEnvironmentOptions

NewCreateEnvironmentOptions : Instantiate CreateEnvironmentOptions

func (*DiscoveryV1) NewCreateEventOptions 

func (discovery *DiscoveryV1) NewCreateEventOptions(typeVar string, data *EventData) *CreateEventOptions

NewCreateEventOptions : Instantiate CreateEventOptions

func (*DiscoveryV1) NewCreateExpansionsOptions 

func (discovery *DiscoveryV1) NewCreateExpansionsOptions(environmentID string, collectionID string) *CreateExpansionsOptions

NewCreateExpansionsOptions : Instantiate CreateExpansionsOptions

func (*DiscoveryV1) NewCreateGatewayOptions added in v0.3.0 

func (discovery *DiscoveryV1) NewCreateGatewayOptions(environmentID string) *CreateGatewayOptions

NewCreateGatewayOptions : Instantiate CreateGatewayOptions

func (*DiscoveryV1) NewCreateStopwordListOptions added in v0.3.0 

func (discovery *DiscoveryV1) NewCreateStopwordListOptions(environmentID string, collectionID string, stopwordFile *os.File, stopwordFilename string) *CreateStopwordListOptions

NewCreateStopwordListOptions : Instantiate CreateStopwordListOptions

func (*DiscoveryV1) NewCreateTokenizationDictionaryOptions added in v0.1.0 

func (discovery *DiscoveryV1) NewCreateTokenizationDictionaryOptions(environmentID string, collectionID string) *CreateTokenizationDictionaryOptions

NewCreateTokenizationDictionaryOptions : Instantiate CreateTokenizationDictionaryOptions

func (*DiscoveryV1) NewCreateTrainingExampleOptions 

func (discovery *DiscoveryV1) NewCreateTrainingExampleOptions(environmentID string, collectionID string, queryID string) *CreateTrainingExampleOptions

NewCreateTrainingExampleOptions : Instantiate CreateTrainingExampleOptions

func (*DiscoveryV1) NewDeleteAllTrainingDataOptions 

func (discovery *DiscoveryV1) NewDeleteAllTrainingDataOptions(environmentID string, collectionID string) *DeleteAllTrainingDataOptions

NewDeleteAllTrainingDataOptions : Instantiate DeleteAllTrainingDataOptions

func (*DiscoveryV1) NewDeleteCollectionOptions 

func (discovery *DiscoveryV1) NewDeleteCollectionOptions(environmentID string, collectionID string) *DeleteCollectionOptions

NewDeleteCollectionOptions : Instantiate DeleteCollectionOptions

func (*DiscoveryV1) NewDeleteConfigurationOptions 

func (discovery *DiscoveryV1) NewDeleteConfigurationOptions(environmentID string, configurationID string) *DeleteConfigurationOptions

NewDeleteConfigurationOptions : Instantiate DeleteConfigurationOptions

func (*DiscoveryV1) NewDeleteCredentialsOptions 

func (discovery *DiscoveryV1) NewDeleteCredentialsOptions(environmentID string, credentialID string) *DeleteCredentialsOptions

NewDeleteCredentialsOptions : Instantiate DeleteCredentialsOptions

func (*DiscoveryV1) NewDeleteDocumentOptions 

func (discovery *DiscoveryV1) NewDeleteDocumentOptions(environmentID string, collectionID string, documentID string) *DeleteDocumentOptions

NewDeleteDocumentOptions : Instantiate DeleteDocumentOptions

func (*DiscoveryV1) NewDeleteEnvironmentOptions 

func (discovery *DiscoveryV1) NewDeleteEnvironmentOptions(environmentID string) *DeleteEnvironmentOptions

NewDeleteEnvironmentOptions : Instantiate DeleteEnvironmentOptions

func (*DiscoveryV1) NewDeleteExpansionsOptions 

func (discovery *DiscoveryV1) NewDeleteExpansionsOptions(environmentID string, collectionID string) *DeleteExpansionsOptions

NewDeleteExpansionsOptions : Instantiate DeleteExpansionsOptions

func (*DiscoveryV1) NewDeleteGatewayOptions added in v0.3.0 

func (discovery *DiscoveryV1) NewDeleteGatewayOptions(environmentID string, gatewayID string) *DeleteGatewayOptions

NewDeleteGatewayOptions : Instantiate DeleteGatewayOptions

func (*DiscoveryV1) NewDeleteStopwordListOptions added in v0.3.0 

func (discovery *DiscoveryV1) NewDeleteStopwordListOptions(environmentID string, collectionID string) *DeleteStopwordListOptions

NewDeleteStopwordListOptions : Instantiate DeleteStopwordListOptions

func (*DiscoveryV1) NewDeleteTokenizationDictionaryOptions added in v0.1.0 

func (discovery *DiscoveryV1) NewDeleteTokenizationDictionaryOptions(environmentID string, collectionID string) *DeleteTokenizationDictionaryOptions

NewDeleteTokenizationDictionaryOptions : Instantiate DeleteTokenizationDictionaryOptions

func (*DiscoveryV1) NewDeleteTrainingDataOptions 

func (discovery *DiscoveryV1) NewDeleteTrainingDataOptions(environmentID string, collectionID string, queryID string) *DeleteTrainingDataOptions

NewDeleteTrainingDataOptions : Instantiate DeleteTrainingDataOptions

func (*DiscoveryV1) NewDeleteTrainingExampleOptions 

func (discovery *DiscoveryV1) NewDeleteTrainingExampleOptions(environmentID string, collectionID string, queryID string, exampleID string) *DeleteTrainingExampleOptions

NewDeleteTrainingExampleOptions : Instantiate DeleteTrainingExampleOptions

func (*DiscoveryV1) NewDeleteUserDataOptions 

func (discovery *DiscoveryV1) NewDeleteUserDataOptions(customerID string) *DeleteUserDataOptions

NewDeleteUserDataOptions : Instantiate DeleteUserDataOptions

func (*DiscoveryV1) NewFederatedQueryNoticesOptions 

func (discovery *DiscoveryV1) NewFederatedQueryNoticesOptions(environmentID string, collectionIds []string) *FederatedQueryNoticesOptions

NewFederatedQueryNoticesOptions : Instantiate FederatedQueryNoticesOptions

func (*DiscoveryV1) NewFederatedQueryOptions 

func (discovery *DiscoveryV1) NewFederatedQueryOptions(environmentID string) *FederatedQueryOptions

NewFederatedQueryOptions : Instantiate FederatedQueryOptions

func (*DiscoveryV1) NewGetCollectionOptions 

func (discovery *DiscoveryV1) NewGetCollectionOptions(environmentID string, collectionID string) *GetCollectionOptions

NewGetCollectionOptions : Instantiate GetCollectionOptions

func (*DiscoveryV1) NewGetConfigurationOptions 

func (discovery *DiscoveryV1) NewGetConfigurationOptions(environmentID string, configurationID string) *GetConfigurationOptions

NewGetConfigurationOptions : Instantiate GetConfigurationOptions

func (*DiscoveryV1) NewGetCredentialsOptions 

func (discovery *DiscoveryV1) NewGetCredentialsOptions(environmentID string, credentialID string) *GetCredentialsOptions

NewGetCredentialsOptions : Instantiate GetCredentialsOptions

func (*DiscoveryV1) NewGetDocumentStatusOptions 

func (discovery *DiscoveryV1) NewGetDocumentStatusOptions(environmentID string, collectionID string, documentID string) *GetDocumentStatusOptions

NewGetDocumentStatusOptions : Instantiate GetDocumentStatusOptions

func (*DiscoveryV1) NewGetEnvironmentOptions 

func (discovery *DiscoveryV1) NewGetEnvironmentOptions(environmentID string) *GetEnvironmentOptions

NewGetEnvironmentOptions : Instantiate GetEnvironmentOptions

func (*DiscoveryV1) NewGetGatewayOptions added in v0.3.0 

func (discovery *DiscoveryV1) NewGetGatewayOptions(environmentID string, gatewayID string) *GetGatewayOptions

NewGetGatewayOptions : Instantiate GetGatewayOptions

func (*DiscoveryV1) NewGetMetricsEventRateOptions 

func (discovery *DiscoveryV1) NewGetMetricsEventRateOptions() *GetMetricsEventRateOptions

NewGetMetricsEventRateOptions : Instantiate GetMetricsEventRateOptions

func (*DiscoveryV1) NewGetMetricsQueryEventOptions 

func (discovery *DiscoveryV1) NewGetMetricsQueryEventOptions() *GetMetricsQueryEventOptions

NewGetMetricsQueryEventOptions : Instantiate GetMetricsQueryEventOptions

func (*DiscoveryV1) NewGetMetricsQueryNoResultsOptions 

func (discovery *DiscoveryV1) NewGetMetricsQueryNoResultsOptions() *GetMetricsQueryNoResultsOptions

NewGetMetricsQueryNoResultsOptions : Instantiate GetMetricsQueryNoResultsOptions

func (*DiscoveryV1) NewGetMetricsQueryOptions 

func (discovery *DiscoveryV1) NewGetMetricsQueryOptions() *GetMetricsQueryOptions

NewGetMetricsQueryOptions : Instantiate GetMetricsQueryOptions

func (*DiscoveryV1) NewGetMetricsQueryTokenEventOptions 

func (discovery *DiscoveryV1) NewGetMetricsQueryTokenEventOptions() *GetMetricsQueryTokenEventOptions

NewGetMetricsQueryTokenEventOptions : Instantiate GetMetricsQueryTokenEventOptions

func (*DiscoveryV1) NewGetTokenizationDictionaryStatusOptions added in v0.1.0 

func (discovery *DiscoveryV1) NewGetTokenizationDictionaryStatusOptions(environmentID string, collectionID string) *GetTokenizationDictionaryStatusOptions

NewGetTokenizationDictionaryStatusOptions : Instantiate GetTokenizationDictionaryStatusOptions

func (*DiscoveryV1) NewGetTrainingDataOptions 

func (discovery *DiscoveryV1) NewGetTrainingDataOptions(environmentID string, collectionID string, queryID string) *GetTrainingDataOptions

NewGetTrainingDataOptions : Instantiate GetTrainingDataOptions

func (*DiscoveryV1) NewGetTrainingExampleOptions 

func (discovery *DiscoveryV1) NewGetTrainingExampleOptions(environmentID string, collectionID string, queryID string, exampleID string) *GetTrainingExampleOptions

NewGetTrainingExampleOptions : Instantiate GetTrainingExampleOptions

func (*DiscoveryV1) NewListCollectionFieldsOptions 

func (discovery *DiscoveryV1) NewListCollectionFieldsOptions(environmentID string, collectionID string) *ListCollectionFieldsOptions

NewListCollectionFieldsOptions : Instantiate ListCollectionFieldsOptions

func (*DiscoveryV1) NewListCollectionsOptions 

func (discovery *DiscoveryV1) NewListCollectionsOptions(environmentID string) *ListCollectionsOptions

NewListCollectionsOptions : Instantiate ListCollectionsOptions

func (*DiscoveryV1) NewListConfigurationsOptions 

func (discovery *DiscoveryV1) NewListConfigurationsOptions(environmentID string) *ListConfigurationsOptions

NewListConfigurationsOptions : Instantiate ListConfigurationsOptions

func (*DiscoveryV1) NewListCredentialsOptions 

func (discovery *DiscoveryV1) NewListCredentialsOptions(environmentID string) *ListCredentialsOptions

NewListCredentialsOptions : Instantiate ListCredentialsOptions

func (*DiscoveryV1) NewListEnvironmentsOptions 

func (discovery *DiscoveryV1) NewListEnvironmentsOptions() *ListEnvironmentsOptions

NewListEnvironmentsOptions : Instantiate ListEnvironmentsOptions

func (*DiscoveryV1) NewListExpansionsOptions 

func (discovery *DiscoveryV1) NewListExpansionsOptions(environmentID string, collectionID string) *ListExpansionsOptions

NewListExpansionsOptions : Instantiate ListExpansionsOptions

func (*DiscoveryV1) NewListFieldsOptions 

func (discovery *DiscoveryV1) NewListFieldsOptions(environmentID string, collectionIds []string) *ListFieldsOptions

NewListFieldsOptions : Instantiate ListFieldsOptions

func (*DiscoveryV1) NewListGatewaysOptions added in v0.3.0 

func (discovery *DiscoveryV1) NewListGatewaysOptions(environmentID string) *ListGatewaysOptions

NewListGatewaysOptions : Instantiate ListGatewaysOptions

func (*DiscoveryV1) NewListTrainingDataOptions 

func (discovery *DiscoveryV1) NewListTrainingDataOptions(environmentID string, collectionID string) *ListTrainingDataOptions

NewListTrainingDataOptions : Instantiate ListTrainingDataOptions

func (*DiscoveryV1) NewListTrainingExamplesOptions 

func (discovery *DiscoveryV1) NewListTrainingExamplesOptions(environmentID string, collectionID string, queryID string) *ListTrainingExamplesOptions

NewListTrainingExamplesOptions : Instantiate ListTrainingExamplesOptions

func (*DiscoveryV1) NewQueryEntitiesOptions 

func (discovery *DiscoveryV1) NewQueryEntitiesOptions(environmentID string, collectionID string) *QueryEntitiesOptions

NewQueryEntitiesOptions : Instantiate QueryEntitiesOptions

func (*DiscoveryV1) NewQueryLogOptions 

func (discovery *DiscoveryV1) NewQueryLogOptions() *QueryLogOptions

NewQueryLogOptions : Instantiate QueryLogOptions

func (*DiscoveryV1) NewQueryNoticesOptions 

func (discovery *DiscoveryV1) NewQueryNoticesOptions(environmentID string, collectionID string) *QueryNoticesOptions

NewQueryNoticesOptions : Instantiate QueryNoticesOptions

func (*DiscoveryV1) NewQueryOptions 

func (discovery *DiscoveryV1) NewQueryOptions(environmentID string, collectionID string) *QueryOptions

NewQueryOptions : Instantiate QueryOptions

func (*DiscoveryV1) NewQueryRelationsOptions 

func (discovery *DiscoveryV1) NewQueryRelationsOptions(environmentID string, collectionID string) *QueryRelationsOptions

NewQueryRelationsOptions : Instantiate QueryRelationsOptions

func (*DiscoveryV1) NewTestConfigurationInEnvironmentOptions 

func (discovery *DiscoveryV1) NewTestConfigurationInEnvironmentOptions(environmentID string) *TestConfigurationInEnvironmentOptions

NewTestConfigurationInEnvironmentOptions : Instantiate TestConfigurationInEnvironmentOptions

func (*DiscoveryV1) NewUpdateCollectionOptions 

func (discovery *DiscoveryV1) NewUpdateCollectionOptions(environmentID string, collectionID string) *UpdateCollectionOptions

NewUpdateCollectionOptions : Instantiate UpdateCollectionOptions

func (*DiscoveryV1) NewUpdateConfigurationOptions 

func (discovery *DiscoveryV1) NewUpdateConfigurationOptions(environmentID string, configurationID string) *UpdateConfigurationOptions

NewUpdateConfigurationOptions : Instantiate UpdateConfigurationOptions

func (*DiscoveryV1) NewUpdateCredentialsOptions 

func (discovery *DiscoveryV1) NewUpdateCredentialsOptions(environmentID string, credentialID string) *UpdateCredentialsOptions

NewUpdateCredentialsOptions : Instantiate UpdateCredentialsOptions

func (*DiscoveryV1) NewUpdateDocumentOptions 

func (discovery *DiscoveryV1) NewUpdateDocumentOptions(environmentID string, collectionID string, documentID string) *UpdateDocumentOptions

NewUpdateDocumentOptions : Instantiate UpdateDocumentOptions

func (*DiscoveryV1) NewUpdateEnvironmentOptions 

func (discovery *DiscoveryV1) NewUpdateEnvironmentOptions(environmentID string) *UpdateEnvironmentOptions

NewUpdateEnvironmentOptions : Instantiate UpdateEnvironmentOptions

func (*DiscoveryV1) NewUpdateTrainingExampleOptions 

func (discovery *DiscoveryV1) NewUpdateTrainingExampleOptions(environmentID string, collectionID string, queryID string, exampleID string) *UpdateTrainingExampleOptions

NewUpdateTrainingExampleOptions : Instantiate UpdateTrainingExampleOptions

func (*DiscoveryV1) Query 

func (discovery *DiscoveryV1) Query(queryOptions *QueryOptions) (*core.DetailedResponse, error)

Query : Long collection queries Complex queries might be too long for a standard method query. By using this method, you can construct longer queries. However, these queries may take longer to complete than the standard method. For details, see the [Discovery service documentation](https://console.bluemix.net/docs/services/discovery/using.html).

func (*DiscoveryV1) QueryEntities 

func (discovery *DiscoveryV1) QueryEntities(queryEntitiesOptions *QueryEntitiesOptions) (*core.DetailedResponse, error)

QueryEntities : Knowledge Graph entity query See the [Knowledge Graph documentation](https://console.bluemix.net/docs/services/discovery/building-kg.html) for more details.

func (*DiscoveryV1) QueryLog 

func (discovery *DiscoveryV1) QueryLog(queryLogOptions *QueryLogOptions) (*core.DetailedResponse, 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) QueryNotices 

func (discovery *DiscoveryV1) QueryNotices(queryNoticesOptions *QueryNoticesOptions) (*core.DetailedResponse, 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 service documentation](https://console.bluemix.net/docs/services/discovery/using.html) for more details on the query language.

func (*DiscoveryV1) QueryRelations 

func (discovery *DiscoveryV1) QueryRelations(queryRelationsOptions *QueryRelationsOptions) (*core.DetailedResponse, error)

QueryRelations : Knowledge Graph relationship query See the [Knowledge Graph documentation](https://console.bluemix.net/docs/services/discovery/building-kg.html) for more details.

func (*DiscoveryV1) TestConfigurationInEnvironment 

func (discovery *DiscoveryV1) TestConfigurationInEnvironment(testConfigurationInEnvironmentOptions *TestConfigurationInEnvironmentOptions) (*core.DetailedResponse, error)

TestConfigurationInEnvironment : Test configuration Runs a sample document through the default or your configuration and returns diagnostic information designed to help you understand how the document was processed. The document is not added to the index.

func (*DiscoveryV1) UpdateCollection 

func (discovery *DiscoveryV1) UpdateCollection(updateCollectionOptions *UpdateCollectionOptions) (*core.DetailedResponse, error)

UpdateCollection : Update a collection

func (*DiscoveryV1) UpdateConfiguration 

func (discovery *DiscoveryV1) UpdateConfiguration(updateConfigurationOptions *UpdateConfigurationOptions) (*core.DetailedResponse, 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) UpdateCredentials 

func (discovery *DiscoveryV1) UpdateCredentials(updateCredentialsOptions *UpdateCredentialsOptions) (*core.DetailedResponse, 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) UpdateDocument 

func (discovery *DiscoveryV1) UpdateDocument(updateDocumentOptions *UpdateDocumentOptions) (*core.DetailedResponse, error)

UpdateDocument : Update a document Replace an existing document. Starts ingesting a document with optional metadata.

func (*DiscoveryV1) UpdateEnvironment 

func (discovery *DiscoveryV1) UpdateEnvironment(updateEnvironmentOptions *UpdateEnvironmentOptions) (*core.DetailedResponse, 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) UpdateTrainingExample 

func (discovery *DiscoveryV1) UpdateTrainingExample(updateTrainingExampleOptions *UpdateTrainingExampleOptions) (*core.DetailedResponse, error)

UpdateTrainingExample : Change label or cross reference for example Changes the label or cross reference query for this training data example.

type DiscoveryV1Options 

type DiscoveryV1Options struct {
	Version        string
	URL            string
	Username       string
	Password       string
	IAMApiKey      string
	IAMAccessToken string
	IAMURL         string
}

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"`

	// **Deprecated**: Total number of bytes available in the environment's disk capacity.
	TotalBytes *int64 `json:"total_bytes,omitempty"`

	// **Deprecated**: Amount of disk capacity used, in KB or GB format.
	Used *string `json:"used,omitempty"`

	// **Deprecated**: Total amount of the environment's disk capacity, in KB or GB format.
	Total *string `json:"total,omitempty"`

	// **Deprecated**: Percentage of the environment's disk capacity that is being used.
	PercentUsed *float64 `json:"percent_used,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.
	Status *string `json:"status,omitempty"`

	// Array of notices produced by the document-ingestion process.
	Notices []Notice `json:"notices,omitempty"`
}

DocumentAccepted : DocumentAccepted struct

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"`
}

DocumentCounts : DocumentCounts struct

type DocumentSnapshot 

type DocumentSnapshot struct {
	Step *string `json:"step,omitempty"`

	Snapshot interface{} `json:"snapshot,omitempty"`
}

DocumentSnapshot : DocumentSnapshot struct

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"`

	// The creation date of the document in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// Date of the most recent document update, in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.
	Updated *strfmt.DateTime `json:"updated,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.
	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://console.bluemix.net/docs/services/discovery/element-classification.html)
	//
	//
	//
	//  Previous API versions also supported `alchemy_language`.
	EnrichmentName *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 struct

type EnrichmentOptions 

type EnrichmentOptions struct {

	// An object representing the enrichment features that will be applied to the specified field.
	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. Models available are: `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.
	Indexed *int64 `json:"indexed,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,omitempty"`
}

Expansions : The query expansion definitions for the specified collection.

type FederatedQueryNoticesOptions 

type FederatedQueryNoticesOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// 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. You
	// cannot use **natural_language_query** and **query** at the same time.
	Query *string `json:"query,omitempty"`

	// A natural language query that returns relevant documents by utilizing training data and natural language
	// understanding. You cannot use **natural_language_query** and **query** at the same time.
	NaturalLanguageQuery *string `json:"natural_language_query,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.
	ReturnFields []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.
	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"`

	// 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"`

	// Allows users to set headers to be GDPR compliant
	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) SetReturnFields 

func (options *FederatedQueryNoticesOptions) SetReturnFields(returnFields []string) *FederatedQueryNoticesOptions

SetReturnFields : Allow user to set ReturnFields

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:"environment_id" 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. You
	// cannot use **natural_language_query** and **query** at the same time.
	Query *string `json:"query,omitempty"`

	// A natural language query that returns relevant documents by utilizing training data and natural language
	// understanding. You cannot use **natural_language_query** and **query** at the same time.
	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.
	ReturnFields *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"`

	// A comma-separated list of collection IDs to be queried against. Required when querying multiple collections, invalid
	// when performing a single collection query.
	CollectionIds *string `json:"collection_ids,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.
	LoggingOptOut *bool `json:"X-Watson-Logging-Opt-Out,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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) SetLoggingOptOut 

func (options *FederatedQueryOptions) SetLoggingOptOut(loggingOptOut bool) *FederatedQueryOptions

SetLoggingOptOut : Allow user to set LoggingOptOut

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) SetReturnFields 

func (options *FederatedQueryOptions) SetReturnFields(returnFields string) *FederatedQueryOptions

SetReturnFields : Allow user to set ReturnFields

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

type Field 

type Field struct {

	// The name of the field.
	FieldName *string `json:"field,omitempty"`

	// The type of the field.
	FieldType *string `json:"type,omitempty"`
}

Field : Field struct

type Filter 

type Filter struct {

	// The match the aggregated results queried for.
	Match *string `json:"match,omitempty"`
}

Filter : Filter struct

type FontSetting 

type FontSetting struct {
	Level *int64 `json:"level,omitempty"`

	MinSize *int64 `json:"min_size,omitempty"`

	MaxSize *int64 `json:"max_size,omitempty"`

	Bold *bool `json:"bold,omitempty"`

	Italic *bool `json:"italic,omitempty"`

	Name *string `json:"name,omitempty"`
}

FontSetting : FontSetting struct

type Gateway added in v0.3.0 

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 added in v0.3.0 

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 added in v0.3.0 

type GatewayList struct {

	// Array of configured gateway connections.
	Gateways []Gateway `json:"gateways,omitempty"`
}

GatewayList : Object containing gateways array.

type GetCollectionOptions 

type GetCollectionOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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:"environment_id" validate:"required"`

	// The ID of the configuration.
	ConfigurationID *string `json:"configuration_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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:"environment_id" validate:"required"`

	// The unique identifier for a set of source credentials.
	CredentialID *string `json:"credential_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The ID of the document.
	DocumentID *string `json:"document_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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:"environment_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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 added in v0.3.0 

type GetGatewayOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The requested gateway ID.
	GatewayID *string `json:"gateway_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

GetGatewayOptions : The getGateway options.

func (*GetGatewayOptions) SetEnvironmentID added in v0.3.0 

func (options *GetGatewayOptions) SetEnvironmentID(environmentID string) *GetGatewayOptions

SetEnvironmentID : Allow user to set EnvironmentID

func (*GetGatewayOptions) SetGatewayID added in v0.3.0 

func (options *GetGatewayOptions) SetGatewayID(gatewayID string) *GetGatewayOptions

SetGatewayID : Allow user to set GatewayID

func (*GetGatewayOptions) SetHeaders added in v0.3.0 

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:"start_time,omitempty"`

	// Metric is computed from data recorded before this timestamp; must be in `YYYY-MM-DDThh:mm:ssZ` format.
	EndTime *strfmt.DateTime `json:"end_time,omitempty"`

	// The type of result to consider when calculating the metric.
	ResultType *string `json:"result_type,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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:"start_time,omitempty"`

	// Metric is computed from data recorded before this timestamp; must be in `YYYY-MM-DDThh:mm:ssZ` format.
	EndTime *strfmt.DateTime `json:"end_time,omitempty"`

	// The type of result to consider when calculating the metric.
	ResultType *string `json:"result_type,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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:"start_time,omitempty"`

	// Metric is computed from data recorded before this timestamp; must be in `YYYY-MM-DDThh:mm:ssZ` format.
	EndTime *strfmt.DateTime `json:"end_time,omitempty"`

	// The type of result to consider when calculating the metric.
	ResultType *string `json:"result_type,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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:"start_time,omitempty"`

	// Metric is computed from data recorded before this timestamp; must be in `YYYY-MM-DDThh:mm:ssZ` format.
	EndTime *strfmt.DateTime `json:"end_time,omitempty"`

	// The type of result to consider when calculating the metric.
	ResultType *string `json:"result_type,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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.
	Count *int64 `json:"count,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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 GetTokenizationDictionaryStatusOptions added in v0.1.0 

type GetTokenizationDictionaryStatusOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

GetTokenizationDictionaryStatusOptions : The getTokenizationDictionaryStatus options.

func (*GetTokenizationDictionaryStatusOptions) SetCollectionID added in v0.1.0 

func (options *GetTokenizationDictionaryStatusOptions) SetCollectionID(collectionID string) *GetTokenizationDictionaryStatusOptions

SetCollectionID : Allow user to set CollectionID

func (*GetTokenizationDictionaryStatusOptions) SetEnvironmentID added in v0.1.0 

func (options *GetTokenizationDictionaryStatusOptions) SetEnvironmentID(environmentID string) *GetTokenizationDictionaryStatusOptions

SetEnvironmentID : Allow user to set EnvironmentID

func (*GetTokenizationDictionaryStatusOptions) SetHeaders added in v0.1.0 

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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The ID of the query used for training.
	QueryID *string `json:"query_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The ID of the query used for training.
	QueryID *string `json:"query_id" validate:"required"`

	// The ID of the document as it is indexed.
	ExampleID *string `json:"example_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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 {
	ExcludeTagsCompletely []string `json:"exclude_tags_completely,omitempty"`

	ExcludeTagsKeepContent []string `json:"exclude_tags_keep_content,omitempty"`

	KeepContent *XPathPatterns `json:"keep_content,omitempty"`

	ExcludeContent *XPathPatterns `json:"exclude_content,omitempty"`

	KeepTagAttributes []string `json:"keep_tag_attributes,omitempty"`

	ExcludeTagAttributes []string `json:"exclude_tag_attributes,omitempty"`
}

HTMLSettings : A list of HTML conversion settings.

type Histogram 

type Histogram struct {

	// 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

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"`

	// **Deprecated**: Summary of the memory usage statistics for this environment.
	MemoryUsage *MemoryUsage `json:"memory_usage,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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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:"environment_id" validate:"required"`

	// Find collections with the given name.
	Name *string `json:"name,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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 : ListCollectionsResponse struct

type ListConfigurationsOptions 

type ListConfigurationsOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// Find configurations with the given name.
	Name *string `json:"name,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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 : ListConfigurationsResponse struct

type ListCredentialsOptions 

type ListCredentialsOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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:"name,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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 : ListEnvironmentsResponse struct

type ListExpansionsOptions 

type ListExpansionsOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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:"environment_id" validate:"required"`

	// A comma-separated list of collection IDs to be queried against.
	CollectionIds []string `json:"collection_ids" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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 added in v0.3.0 

type ListGatewaysOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

ListGatewaysOptions : The listGateways options.

func (*ListGatewaysOptions) SetEnvironmentID added in v0.3.0 

func (options *ListGatewaysOptions) SetEnvironmentID(environmentID string) *ListGatewaysOptions

SetEnvironmentID : Allow user to set EnvironmentID

func (*ListGatewaysOptions) SetHeaders added in v0.3.0 

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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The ID of the query used for training.
	QueryID *string `json:"query_id" validate:"required"`

	// Allows users to set headers to be GDPR compliant
	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"`

	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 {
	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 MemoryUsage 

type MemoryUsage struct {

	// **Deprecated**: Number of bytes used in the environment's memory capacity.
	UsedBytes *int64 `json:"used_bytes,omitempty"`

	// **Deprecated**: Total number of bytes available in the environment's memory capacity.
	TotalBytes *int64 `json:"total_bytes,omitempty"`

	// **Deprecated**: Amount of memory capacity used, in KB or GB format.
	Used *string `json:"used,omitempty"`

	// **Deprecated**: Total amount of the environment's memory capacity, in KB or GB format.
	Total *string `json:"total,omitempty"`

	// **Deprecated**: Percentage of the environment's memory capacity that is being used.
	PercentUsed *float64 `json:"percent_used,omitempty"`
}

MemoryUsage : **Deprecated**: Summary of the memory usage statistics for this environment.

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"`

	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 {
	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"`

	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 {
	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 area of the results the aggregation was restricted to.
	Path *string `json:"path,omitempty"`
}

Nested : Nested struct

type NluEnrichmentCategories 

type NluEnrichmentCategories map[string]interface{}

NluEnrichmentCategories : An object that indicates the Categories enrichment will be applied to the specified field.

type NluEnrichmentConcepts added in v0.2.0 

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, the
	// public model for use with Knowledge Graph `en-news`, 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 *NluEnrichmentCategories `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 : NluEnrichmentFeatures struct

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 public model for use with Knowledge Graph
	// `en-news`, the default 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 JSON tree. **source_field** and
	// **destination_field** are ignored by this operation because _remove_nulls_ operates on the entire JSON tree.
	// 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 : NormalizationOperation struct

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.
	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.
	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 {
	Fonts []FontSetting `json:"fonts,omitempty"`
}

PdfHeadingDetection : PdfHeadingDetection struct

type PdfSettings 

type PdfSettings struct {
	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"`

	Results []AggregationResult `json:"results,omitempty"`

	// Number of matching results.
	MatchingResults *int64 `json:"matching_results,omitempty"`

	// Aggregations returned by the Discovery service.
	Aggregations []QueryAggregation `json:"aggregations,omitempty"`
}

QueryAggregation : An aggregation produced by the Discovery service to analyze the input provided.

type QueryEntitiesContext 

type QueryEntitiesContext struct {

	// Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted
	// to query the city of London in England your query would look for `London` with the context of `England`.
	Text *string `json:"text,omitempty"`
}

QueryEntitiesContext : Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted to query the city of London in England your query would look for `London` with the context of `England`.

type QueryEntitiesEntity 

type QueryEntitiesEntity struct {

	// Entity text content.
	Text *string `json:"text,omitempty"`

	// The type of the specified entity.
	Type *string `json:"type,omitempty"`
}

QueryEntitiesEntity : A text string that appears within the entity text field.

type QueryEntitiesOptions 

type QueryEntitiesOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The entity query feature to perform. Supported features are `disambiguate` and `similar_entities`.
	Feature *string `json:"feature,omitempty"`

	// A text string that appears within the entity text field.
	Entity *QueryEntitiesEntity `json:"entity,omitempty"`

	// Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted
	// to query the city of London in England your query would look for `London` with the context of `England`.
	Context *QueryEntitiesContext `json:"context,omitempty"`

	// The number of results to return. The default is `10`. The maximum is `1000`.
	Count *int64 `json:"count,omitempty"`

	// The number of evidence items to return for each result. The default is `0`. The maximum number of evidence items per
	// query is 10,000.
	EvidenceCount *int64 `json:"evidence_count,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

QueryEntitiesOptions : The queryEntities options.

func (*QueryEntitiesOptions) SetCollectionID 

func (options *QueryEntitiesOptions) SetCollectionID(collectionID string) *QueryEntitiesOptions

SetCollectionID : Allow user to set CollectionID

func (*QueryEntitiesOptions) SetContext 

func (options *QueryEntitiesOptions) SetContext(context *QueryEntitiesContext) *QueryEntitiesOptions

SetContext : Allow user to set Context

func (*QueryEntitiesOptions) SetCount 

func (options *QueryEntitiesOptions) SetCount(count int64) *QueryEntitiesOptions

SetCount : Allow user to set Count

func (*QueryEntitiesOptions) SetEntity 

func (options *QueryEntitiesOptions) SetEntity(entity *QueryEntitiesEntity) *QueryEntitiesOptions

SetEntity : Allow user to set Entity

func (*QueryEntitiesOptions) SetEnvironmentID 

func (options *QueryEntitiesOptions) SetEnvironmentID(environmentID string) *QueryEntitiesOptions

SetEnvironmentID : Allow user to set EnvironmentID

func (*QueryEntitiesOptions) SetEvidenceCount 

func (options *QueryEntitiesOptions) SetEvidenceCount(evidenceCount int64) *QueryEntitiesOptions

SetEvidenceCount : Allow user to set EvidenceCount

func (*QueryEntitiesOptions) SetFeature 

func (options *QueryEntitiesOptions) SetFeature(feature string) *QueryEntitiesOptions

SetFeature : Allow user to set Feature

func (*QueryEntitiesOptions) SetHeaders 

func (options *QueryEntitiesOptions) SetHeaders(param map[string]string) *QueryEntitiesOptions

SetHeaders : Allow user to set Headers

type QueryEntitiesResponse 

type QueryEntitiesResponse struct {
	Entities []QueryEntitiesResponseItem `json:"entities,omitempty"`
}

QueryEntitiesResponse : An array of entities resulting from the query.

type QueryEntitiesResponseItem 

type QueryEntitiesResponseItem struct {

	// Entity text content.
	Text *string `json:"text,omitempty"`

	// The type of the result entity.
	Type *string `json:"type,omitempty"`

	// List of different evidentiary items to support the result.
	Evidence []QueryEvidence `json:"evidence,omitempty"`
}

QueryEntitiesResponseItem : Object containing Entity query response information.

type QueryEvidence 

type QueryEvidence struct {

	// The docuemnt ID (as indexed in Discovery) of the evidence location.
	DocumentID *string `json:"document_id,omitempty"`

	// The field of the document where the supporting evidence was identified.
	Field *string `json:"field,omitempty"`

	// The start location of the evidence in the identified field. This value is inclusive.
	StartOffset *int64 `json:"start_offset,omitempty"`

	// The end location of the evidence in the identified field. This value is inclusive.
	EndOffset *int64 `json:"end_offset,omitempty"`

	// An array of entity objects that show evidence of the result.
	Entities []QueryEvidenceEntity `json:"entities,omitempty"`
}

QueryEvidence : Description of evidence location supporting Knoweldge Graph query result.

type QueryEvidenceEntity 

type QueryEvidenceEntity struct {

	// The entity type for this entity. Possible types vary based on model used.
	Type *string `json:"type,omitempty"`

	// The original text of this entity as found in the evidence field.
	Text *string `json:"text,omitempty"`

	// The start location of the entity text in the identified field. This value is inclusive.
	StartOffset *int64 `json:"start_offset,omitempty"`

	// The end location of the entity text in the identified field. This value is exclusive.
	EndOffset *int64 `json:"end_offset,omitempty"`
}

QueryEvidenceEntity : Entity description and location within evidence field.

type QueryFilterType 

type QueryFilterType struct {

	// A comma-separated list of types to exclude.
	Exclude []string `json:"exclude,omitempty"`

	// A comma-separated list of types to include. All other types are excluded.
	Include []string `json:"include,omitempty"`
}

QueryFilterType : QueryFilterType struct

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:"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. You
	// cannot use **natural_language_query** and **query** at the same time.
	Query *string `json:"query,omitempty"`

	// Number of results to return.
	Count *int64 `json:"count,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.
	Sort []string `json:"sort,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" 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. You
	// cannot use **natural_language_query** and **query** at the same time.
	Query *string `json:"query,omitempty"`

	// A natural language query that returns relevant documents by utilizing training data and natural language
	// understanding. You cannot use **natural_language_query** and **query** at the same time.
	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.
	ReturnFields []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.
	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.
	PassagesCount *int64 `json:"passages.count,omitempty"`

	// The approximate number of characters that any one passage will have.
	PassagesCharacters *int64 `json:"passages.characters,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"`

	// Allows users to set headers to be GDPR compliant
	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) SetReturnFields 

func (options *QueryNoticesOptions) SetReturnFields(returnFields []string) *QueryNoticesOptions

SetReturnFields : Allow user to set ReturnFields

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 {
	MatchingResults *int64 `json:"matching_results,omitempty"`

	Results []QueryNoticesResult `json:"results,omitempty"`

	Aggregations []QueryAggregation `json:"aggregations,omitempty"`

	Passages []QueryPassages `json:"passages,omitempty"`

	DuplicatesRemoved *int64 `json:"duplicates_removed,omitempty"`
}

QueryNoticesResponse : QueryNoticesResponse struct

type QueryNoticesResult 

type QueryNoticesResult map[string]interface{}

QueryNoticesResult : QueryNoticesResult struct

func (*QueryNoticesResult) GetCode added in v0.3.0 

func (this *QueryNoticesResult) GetCode() *int64

GetCode : Allow user to get Code

func (*QueryNoticesResult) GetCollectionID added in v0.3.0 

func (this *QueryNoticesResult) GetCollectionID() *string

GetCollectionID : Allow user to get CollectionID

func (*QueryNoticesResult) GetFileType added in v0.3.0 

func (this *QueryNoticesResult) GetFileType() *string

GetFileType : Allow user to get FileType

func (*QueryNoticesResult) GetFilename added in v0.3.0 

func (this *QueryNoticesResult) GetFilename() *string

GetFilename : Allow user to get Filename

func (*QueryNoticesResult) GetID added in v0.3.0 

func (this *QueryNoticesResult) GetID() *string

GetID : Allow user to get ID

func (*QueryNoticesResult) GetMetadata added in v0.3.0 

func (this *QueryNoticesResult) GetMetadata() *interface{}

GetMetadata : Allow user to get Metadata

func (*QueryNoticesResult) GetNotices added in v0.3.0 

func (this *QueryNoticesResult) GetNotices() *[]Notice

GetNotices : Allow user to get Notices

func (*QueryNoticesResult) GetResultMetadata added in v0.3.0 

func (this *QueryNoticesResult) GetResultMetadata() *QueryResultMetadata

GetResultMetadata : Allow user to get ResultMetadata

func (*QueryNoticesResult) GetScore added in v0.3.0 

func (this *QueryNoticesResult) GetScore() *float64

GetScore : Allow user to get Score

func (*QueryNoticesResult) GetSha1 added in v0.3.0 

func (this *QueryNoticesResult) GetSha1() *string

GetSha1 : Allow user to get Sha1

func (*QueryNoticesResult) SetCode added in v0.3.0 

func (this *QueryNoticesResult) SetCode(Code *int64)

SetCode : Allow user to set Code

func (*QueryNoticesResult) SetCollectionID added in v0.3.0 

func (this *QueryNoticesResult) SetCollectionID(CollectionID *string)

SetCollectionID : Allow user to set CollectionID

func (*QueryNoticesResult) SetFileType added in v0.3.0 

func (this *QueryNoticesResult) SetFileType(FileType *string)

SetFileType : Allow user to set FileType

func (*QueryNoticesResult) SetFilename added in v0.3.0 

func (this *QueryNoticesResult) SetFilename(Filename *string)

SetFilename : Allow user to set Filename

func (*QueryNoticesResult) SetID added in v0.3.0 

func (this *QueryNoticesResult) SetID(ID *string)

SetID : Allow user to set ID

func (*QueryNoticesResult) SetMetadata added in v0.3.0 

func (this *QueryNoticesResult) SetMetadata(Metadata *interface{})

SetMetadata : Allow user to set Metadata

func (*QueryNoticesResult) SetNotices added in v0.3.0 

func (this *QueryNoticesResult) SetNotices(Notices *[]Notice)

SetNotices : Allow user to set Notices

func (*QueryNoticesResult) SetResultMetadata added in v0.3.0 

func (this *QueryNoticesResult) SetResultMetadata(ResultMetadata *QueryResultMetadata)

SetResultMetadata : Allow user to set ResultMetadata

func (*QueryNoticesResult) SetScore added in v0.3.0 

func (this *QueryNoticesResult) SetScore(Score *float64)

SetScore : Allow user to set Score

func (*QueryNoticesResult) SetSha1 added in v0.3.0 

func (this *QueryNoticesResult) SetSha1(Sha1 *string)

SetSha1 : Allow user to set Sha1

type QueryOptions 

type QueryOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" 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. You
	// cannot use **natural_language_query** and **query** at the same time.
	Query *string `json:"query,omitempty"`

	// A natural language query that returns relevant documents by utilizing training data and natural language
	// understanding. You cannot use **natural_language_query** and **query** at the same time.
	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.
	ReturnFields *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"`

	// A comma-separated list of collection IDs to be queried against. Required when querying multiple collections, invalid
	// when performing a single collection query.
	CollectionIds *string `json:"collection_ids,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.
	LoggingOptOut *bool `json:"X-Watson-Logging-Opt-Out,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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) SetCollectionIds 

func (options *QueryOptions) SetCollectionIds(collectionIds string) *QueryOptions

SetCollectionIds : Allow user to set CollectionIds

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) SetLoggingOptOut 

func (options *QueryOptions) SetLoggingOptOut(loggingOptOut bool) *QueryOptions

SetLoggingOptOut : Allow user to set LoggingOptOut

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) SetReturnFields 

func (options *QueryOptions) SetReturnFields(returnFields string) *QueryOptions

SetReturnFields : Allow user to set ReturnFields

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

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 : QueryPassages struct

type QueryRelationsArgument 

type QueryRelationsArgument struct {
	Entities []QueryEntitiesEntity `json:"entities,omitempty"`
}

QueryRelationsArgument : QueryRelationsArgument struct

type QueryRelationsEntity 

type QueryRelationsEntity struct {

	// Entity text content.
	Text *string `json:"text,omitempty"`

	// The type of the specified entity.
	Type *string `json:"type,omitempty"`

	// If false, implicit querying is performed. The default is `false`.
	Exact *bool `json:"exact,omitempty"`
}

QueryRelationsEntity : QueryRelationsEntity struct

type QueryRelationsFilter 

type QueryRelationsFilter struct {

	// A list of relation types to include or exclude from the query.
	RelationTypes *QueryFilterType `json:"relation_types,omitempty"`

	// A list of entity types to include or exclude from the query.
	EntityTypes *QueryFilterType `json:"entity_types,omitempty"`

	// A comma-separated list of document IDs to include in the query.
	DocumentIds []string `json:"document_ids,omitempty"`
}

QueryRelationsFilter : QueryRelationsFilter struct

type QueryRelationsOptions 

type QueryRelationsOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// An array of entities to find relationships for.
	Entities []QueryRelationsEntity `json:"entities,omitempty"`

	// Entity text to provide context for the queried entity and rank based on that association. For example, if you wanted
	// to query the city of London in England your query would look for `London` with the context of `England`.
	Context *QueryEntitiesContext `json:"context,omitempty"`

	// The sorting method for the relationships, can be `score` or `frequency`. `frequency` is the number of unique times
	// each entity is identified. The default is `score`. This parameter cannot be used in the same query as the **bias**
	// parameter.
	Sort *string `json:"sort,omitempty"`

	// Filters to apply to the relationship query.
	Filter *QueryRelationsFilter `json:"filter,omitempty"`

	// The number of results to return. The default is `10`. The maximum is `1000`.
	Count *int64 `json:"count,omitempty"`

	// The number of evidence items to return for each result. The default is `0`. The maximum number of evidence items per
	// query is 10,000.
	EvidenceCount *int64 `json:"evidence_count,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

QueryRelationsOptions : The queryRelations options.

func (*QueryRelationsOptions) SetCollectionID 

func (options *QueryRelationsOptions) SetCollectionID(collectionID string) *QueryRelationsOptions

SetCollectionID : Allow user to set CollectionID

func (*QueryRelationsOptions) SetContext 

func (options *QueryRelationsOptions) SetContext(context *QueryEntitiesContext) *QueryRelationsOptions

SetContext : Allow user to set Context

func (*QueryRelationsOptions) SetCount 

func (options *QueryRelationsOptions) SetCount(count int64) *QueryRelationsOptions

SetCount : Allow user to set Count

func (*QueryRelationsOptions) SetEntities 

func (options *QueryRelationsOptions) SetEntities(entities []QueryRelationsEntity) *QueryRelationsOptions

SetEntities : Allow user to set Entities

func (*QueryRelationsOptions) SetEnvironmentID 

func (options *QueryRelationsOptions) SetEnvironmentID(environmentID string) *QueryRelationsOptions

SetEnvironmentID : Allow user to set EnvironmentID

func (*QueryRelationsOptions) SetEvidenceCount 

func (options *QueryRelationsOptions) SetEvidenceCount(evidenceCount int64) *QueryRelationsOptions

SetEvidenceCount : Allow user to set EvidenceCount

func (*QueryRelationsOptions) SetFilter 

func (options *QueryRelationsOptions) SetFilter(filter *QueryRelationsFilter) *QueryRelationsOptions

SetFilter : Allow user to set Filter

func (*QueryRelationsOptions) SetHeaders 

func (options *QueryRelationsOptions) SetHeaders(param map[string]string) *QueryRelationsOptions

SetHeaders : Allow user to set Headers

func (*QueryRelationsOptions) SetSort 

func (options *QueryRelationsOptions) SetSort(sort string) *QueryRelationsOptions

SetSort : Allow user to set Sort

type QueryRelationsRelationship 

type QueryRelationsRelationship struct {

	// The identified relationship type.
	Type *string `json:"type,omitempty"`

	// The number of times the relationship is mentioned.
	Frequency *int64 `json:"frequency,omitempty"`

	// Information about the relationship.
	Arguments []QueryRelationsArgument `json:"arguments,omitempty"`

	// List of different evidentiary items to support the result.
	Evidence []QueryEvidence `json:"evidence,omitempty"`
}

QueryRelationsRelationship : QueryRelationsRelationship struct

type QueryRelationsResponse 

type QueryRelationsResponse struct {
	Relations []QueryRelationsRelationship `json:"relations,omitempty"`
}

QueryRelationsResponse : QueryRelationsResponse struct

type QueryResponse 

type QueryResponse struct {
	MatchingResults *int64 `json:"matching_results,omitempty"`

	Results []QueryResult `json:"results,omitempty"`

	Aggregations []QueryAggregation `json:"aggregations,omitempty"`

	Passages []QueryPassages `json:"passages,omitempty"`

	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"`
}

QueryResponse : A response containing the documents and aggregations for the query.

type QueryResult 

type QueryResult map[string]interface{}

QueryResult : QueryResult struct

func (*QueryResult) GetCollectionID added in v0.3.0 

func (this *QueryResult) GetCollectionID() *string

GetCollectionID : Allow user to get CollectionID

func (*QueryResult) GetID added in v0.3.0 

func (this *QueryResult) GetID() *string

GetID : Allow user to get ID

func (*QueryResult) GetMetadata added in v0.3.0 

func (this *QueryResult) GetMetadata() *interface{}

GetMetadata : Allow user to get Metadata

func (*QueryResult) GetResultMetadata added in v0.3.0 

func (this *QueryResult) GetResultMetadata() *QueryResultMetadata

GetResultMetadata : Allow user to get ResultMetadata

func (*QueryResult) GetScore added in v0.3.0 

func (this *QueryResult) GetScore() *float64

GetScore : Allow user to get Score

func (*QueryResult) SetCollectionID added in v0.3.0 

func (this *QueryResult) SetCollectionID(CollectionID *string)

SetCollectionID : Allow user to set CollectionID

func (*QueryResult) SetID added in v0.3.0 

func (this *QueryResult) SetID(ID *string)

SetID : Allow user to set ID

func (*QueryResult) SetMetadata added in v0.3.0 

func (this *QueryResult) SetMetadata(Metadata *interface{})

SetMetadata : Allow user to set Metadata

func (*QueryResult) SetResultMetadata added in v0.3.0 

func (this *QueryResult) SetResultMetadata(ResultMetadata *QueryResultMetadata)

SetResultMetadata : Allow user to set ResultMetadata

func (*QueryResult) SetScore added in v0.3.0 

func (this *QueryResult) SetScore(Score *float64)

SetScore : Allow user to set Score

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" validate:"required"`
}

QueryResultMetadata : Metadata of a query result.

type RetrievalDetails added in v0.2.0 

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 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.
	SelectorTags []string `json:"selector_tags,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.
	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"`
}

SourceOptions : The **options** object defines which items to crawl from the source system.

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 added in v0.3.0 

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"`
}

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**.
	//
	// -  `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.
	// -  `complete_with_notices` indicates that some notices were generated during the crawl. Notices can be checked by
	// using the **notices** query method.
	// -  `stopped` indicates that the crawl has stopped but is not complete.
	Status *string `json:"status,omitempty"`

	// Date in UTC format indicating when the last crawl was attempted. If `null`, no crawl was completed.
	LastUpdated *strfmt.DateTime `json:"last_updated,omitempty"`
}

SourceStatus : Object containing source crawl status information.

type Term 

type Term struct {

	// The field where the aggregation is located in the document.
	Field *string `json:"field,omitempty"`

	Count *int64 `json:"count,omitempty"`
}

Term : Term struct

type TestConfigurationInEnvironmentOptions 

type TestConfigurationInEnvironmentOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The configuration to use to process the document. If this part is provided, then the provided configuration is used
	// to process the document. If the **configuration_id** is also provided (both are present at the same time), then
	// request is rejected. The maximum supported configuration size is 1 MB. Configuration parts larger than 1 MB are
	// rejected.
	// See the `GET /configurations/{configuration_id}` operation for an example configuration.
	Configuration *string `json:"configuration,omitempty"`

	// Specify to only run the input document through the given step instead of running the input document through the
	// entire ingestion workflow. Valid values are `convert`, `enrich`, and `normalize`.
	Step *string `json:"step,omitempty"`

	// The ID of the configuration to use to process the document. If the **configuration** form part is also provided
	// (both are present at the same time), then the request will be rejected.
	ConfigurationID *string `json:"configuration_id,omitempty"`

	// The content of the document to ingest. The maximum supported file size is 50 megabytes. Files larger than 50
	// megabytes is rejected.
	File *os.File `json:"file,omitempty"`

	// The filename for file.
	Filename *string `json:"filename,omitempty"`

	// If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata that
	// the Data Crawler might send. 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:"metadata,omitempty"`

	// The content type of file. Values for this parameter can be obtained from the HttpMediaType class.
	FileContentType *string `json:"file_content_type,omitempty"`

	// Allows users to set headers to be GDPR compliant
	Headers map[string]string
}

TestConfigurationInEnvironmentOptions : The testConfigurationInEnvironment options.

func (*TestConfigurationInEnvironmentOptions) SetConfiguration 

func (options *TestConfigurationInEnvironmentOptions) SetConfiguration(configuration string) *TestConfigurationInEnvironmentOptions

SetConfiguration : Allow user to set Configuration

func (*TestConfigurationInEnvironmentOptions) SetConfigurationID 

func (options *TestConfigurationInEnvironmentOptions) SetConfigurationID(configurationID string) *TestConfigurationInEnvironmentOptions

SetConfigurationID : Allow user to set ConfigurationID

func (*TestConfigurationInEnvironmentOptions) SetEnvironmentID 

func (options *TestConfigurationInEnvironmentOptions) SetEnvironmentID(environmentID string) *TestConfigurationInEnvironmentOptions

SetEnvironmentID : Allow user to set EnvironmentID

func (*TestConfigurationInEnvironmentOptions) SetFile 

func (options *TestConfigurationInEnvironmentOptions) SetFile(file *os.File) *TestConfigurationInEnvironmentOptions

SetFile : Allow user to set File

func (*TestConfigurationInEnvironmentOptions) SetFileContentType 

func (options *TestConfigurationInEnvironmentOptions) SetFileContentType(fileContentType string) *TestConfigurationInEnvironmentOptions

SetFileContentType : Allow user to set FileContentType

func (*TestConfigurationInEnvironmentOptions) SetFilename 

func (options *TestConfigurationInEnvironmentOptions) SetFilename(filename string) *TestConfigurationInEnvironmentOptions

SetFilename : Allow user to set Filename

func (*TestConfigurationInEnvironmentOptions) SetHeaders 

func (options *TestConfigurationInEnvironmentOptions) SetHeaders(param map[string]string) *TestConfigurationInEnvironmentOptions

SetHeaders : Allow user to set Headers

func (*TestConfigurationInEnvironmentOptions) SetMetadata 

func (options *TestConfigurationInEnvironmentOptions) SetMetadata(metadata string) *TestConfigurationInEnvironmentOptions

SetMetadata : Allow user to set Metadata

func (*TestConfigurationInEnvironmentOptions) SetStep 

func (options *TestConfigurationInEnvironmentOptions) SetStep(step string) *TestConfigurationInEnvironmentOptions

SetStep : Allow user to set Step

type TestDocument 

type TestDocument struct {

	// The unique identifier for the configuration.
	ConfigurationID *string `json:"configuration_id,omitempty"`

	// Status of the preview operation.
	Status *string `json:"status,omitempty"`

	// The number of 10-kB chunks of field data that were enriched. This can be used to estimate the cost of running a real
	// ingestion.
	EnrichedFieldUnits *int64 `json:"enriched_field_units,omitempty"`

	// Format of the test document.
	OriginalMediaType *string `json:"original_media_type,omitempty"`

	// An array of objects that describe each step in the preview process.
	Snapshots []DocumentSnapshot `json:"snapshots,omitempty"`

	// An array of notice messages about the preview operation.
	Notices []Notice `json:"notices,omitempty"`
}

TestDocument : TestDocument struct

type Timeslice 

type Timeslice struct {

	// 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

type TokenDictRule added in v0.1.0 

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 added in v0.1.0 

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 {

	// Number of top hits returned by the aggregation.
	Size *int64 `json:"size,omitempty"`

	Hits *TopHitsResults `json:"hits,omitempty"`
}

TopHits : TopHits struct

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 : TopHitsResults struct

type TrainingDataSet 

type TrainingDataSet struct {
	EnvironmentID *string `json:"environment_id,omitempty"`

	CollectionID *string `json:"collection_id,omitempty"`

	Queries []TrainingQuery `json:"queries,omitempty"`
}

TrainingDataSet : TrainingDataSet struct

type TrainingExample 

type TrainingExample struct {
	DocumentID *string `json:"document_id,omitempty"`

	CrossReference *string `json:"cross_reference,omitempty"`

	Relevance *int64 `json:"relevance,omitempty"`
}

TrainingExample : TrainingExample struct

type TrainingExampleList 

type TrainingExampleList struct {
	Examples []TrainingExample `json:"examples,omitempty"`
}

TrainingExampleList : TrainingExampleList struct

type TrainingQuery 

type TrainingQuery struct {
	QueryID *string `json:"query_id,omitempty"`

	NaturalLanguageQuery *string `json:"natural_language_query,omitempty"`

	Filter *string `json:"filter,omitempty"`

	Examples []TrainingExample `json:"examples,omitempty"`
}

TrainingQuery : TrainingQuery struct

type TrainingStatus 

type TrainingStatus struct {
	TotalExamples *int64 `json:"total_examples,omitempty"`

	Available *bool `json:"available,omitempty"`

	Processing *bool `json:"processing,omitempty"`

	MinimumQueriesAdded *bool `json:"minimum_queries_added,omitempty"`

	MinimumExamplesAdded *bool `json:"minimum_examples_added,omitempty"`

	SufficientLabelDiversity *bool `json:"sufficient_label_diversity,omitempty"`

	Notices *int64 `json:"notices,omitempty"`

	SuccessfullyTrained *strfmt.DateTime `json:"successfully_trained,omitempty"`

	DataUpdated *strfmt.DateTime `json:"data_updated,omitempty"`
}

TrainingStatus : TrainingStatus struct

type UpdateCollectionOptions 

type UpdateCollectionOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The name of the collection.
	Name *string `json:"name,omitempty"`

	// 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 to be GDPR compliant
	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:"environment_id" validate:"required"`

	// The ID of the configuration.
	ConfigurationID *string `json:"configuration_id" validate:"required"`

	// The name of the configuration.
	Name *string `json:"name,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"`

	// Allows users to set headers to be GDPR compliant
	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:"environment_id" validate:"required"`

	// The unique identifier for a set of source credentials.
	CredentialID *string `json:"credential_id" validate:"required"`

	// 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.
	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"`

	// Allows users to set headers to be GDPR compliant
	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

type UpdateDocumentOptions 

type UpdateDocumentOptions struct {

	// The ID of the environment.
	EnvironmentID *string `json:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The ID of the document.
	DocumentID *string `json:"document_id" validate:"required"`

	// The content of the document to ingest. The maximum supported file size is 50 megabytes. Files larger than 50
	// megabytes is rejected.
	File *os.File `json:"file,omitempty"`

	// The filename for file.
	Filename *string `json:"filename,omitempty"`

	// If you're using the Data Crawler to upload your documents, you can test a document against the type of metadata that
	// the Data Crawler might send. 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:"metadata,omitempty"`

	// The content type of file. Values for this parameter can be obtained from the HttpMediaType class.
	FileContentType *string `json:"file_content_type,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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 *os.File) *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:"environment_id" validate:"required"`

	// 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 to be GDPR compliant
	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:"environment_id" validate:"required"`

	// The ID of the collection.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The ID of the query used for training.
	QueryID *string `json:"query_id" validate:"required"`

	// The ID of the document as it is indexed.
	ExampleID *string `json:"example_id" validate:"required"`

	CrossReference *string `json:"cross_reference,omitempty"`

	Relevance *int64 `json:"relevance,omitempty"`

	// Allows users to set headers to be GDPR compliant
	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 {
	Fonts []FontSetting `json:"fonts,omitempty"`

	Styles []WordStyle `json:"styles,omitempty"`
}

WordHeadingDetection : WordHeadingDetection struct

type WordSettings 

type WordSettings struct {
	Heading *WordHeadingDetection `json:"heading,omitempty"`
}

WordSettings : A list of Word conversion settings.

type WordStyle 

type WordStyle struct {
	Level *int64 `json:"level,omitempty"`

	Names []string `json:"names,omitempty"`
}

WordStyle : WordStyle struct

type XPathPatterns 

type XPathPatterns struct {
	Xpaths []string `json:"xpaths,omitempty"`
}

XPathPatterns : XPathPatterns struct

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.