discoveryv1

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 when adding a file to a collection is 50
	// megabytes, the maximum supported file size when testing a configuration is 1 megabyte. Files larger than the
	// supported size are rejected.
	File io.ReadCloser `json:"file,omitempty"`

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

	// The content type of file.
	FileContentType *string `json:"file_content_type,omitempty"`

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

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

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

	// The natural text query for the new training query.
	NaturalLanguageQuery *string `json:"natural_language_query,omitempty"`

	// The filter used on the collection before the **natural_language_query** is applied.
	Filter *string `json:"filter,omitempty"`

	// Array of training examples.
	Examples []TrainingExample `json:"examples,omitempty"`

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

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

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

type Collection struct {

	// The unique identifier of the collection.
	CollectionID *string `json:"collection_id,omitempty"`

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

	// The description of the collection.
	Description *string `json:"description,omitempty"`

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

	// The timestamp of when the collection was last updated in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.
	Updated *strfmt.DateTime `json:"updated,omitempty"`

	// The status of the collection.
	Status *string `json:"status,omitempty"`

	// The unique identifier of the collection's configuration.
	ConfigurationID *string `json:"configuration_id,omitempty"`

	// The language of the documents stored in the collection. Permitted values include `en` (English), `de` (German), and
	// `es` (Spanish).
	Language *string `json:"language,omitempty"`

	// Object containing collection document count information.
	DocumentCounts *DocumentCounts `json:"document_counts,omitempty"`

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

	// Training status details.
	TrainingStatus *TrainingStatus `json:"training_status,omitempty"`

	// Object containing information about the crawl status of this collection.
	CrawlStatus *CollectionCrawlStatus `json:"crawl_status,omitempty"`

	// Object containing smart document understanding information for this collection.
	SmartDocumentUnderstanding *SduStatus `json:"smart_document_understanding,omitempty"`
}

type CollectionCrawlStatus struct {

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

type CollectionDiskUsage struct {

	// Number of bytes used by the collection.
	UsedBytes *int64 `json:"used_bytes,omitempty"`
}

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

type Completions struct {

	// Array of autcomplete suggestion based on the provided prefix.
	Completions []string `json:"completions,omitempty"`
}

type Configuration struct {

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

	// The name of the configuration.
	Name *string `json:"name" validate:"required"`

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

	// The timestamp of when the configuration was last updated in the format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'.
	Updated *strfmt.DateTime `json:"updated,omitempty"`

	// The description of the configuration, if available.
	Description *string `json:"description,omitempty"`

	// Document conversion settings.
	Conversions *Conversions `json:"conversions,omitempty"`

	// An array of document enrichment settings for the configuration.
	Enrichments []Enrichment `json:"enrichments,omitempty"`

	// Defines operations that can be used to transform the final output JSON into a normalized form. Operations are
	// executed in the order that they appear in the array.
	Normalizations []NormalizationOperation `json:"normalizations,omitempty"`

	// Object containing source parameters for the configuration.
	Source *Source `json:"source,omitempty"`
}

type Conversions struct {

	// A list of PDF conversion settings.
	Pdf *PdfSettings `json:"pdf,omitempty"`

	// A list of Word conversion settings.
	Word *WordSettings `json:"word,omitempty"`

	// A list of HTML conversion settings.
	HTML *HTMLSettings `json:"html,omitempty"`

	// A list of Document Segmentation settings.
	Segment *SegmentSettings `json:"segment,omitempty"`

	// Defines operations that can be used to transform the final output JSON into a normalized form. Operations are
	// executed in the order that they appear in the array.
	JSONNormalizations []NormalizationOperation `json:"json_normalizations,omitempty"`

	// When `true`, automatic text extraction from images (this includes images embedded in supported document formats, for
	// example PDF, and suppported image formats, for example TIFF) is performed on documents uploaded to the collection.
	// This field is supported on **Advanced** and higher plans only. **Lite** plans do not support image text recognition.
	ImageTextRecognition *bool `json:"image_text_recognition,omitempty"`
}

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
}

type CreateConfigurationOptions struct {

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

	// The name of the configuration.
	Name *string `json:"name" validate:"required"`

	// The description of the configuration, if available.
	Description *string `json:"description,omitempty"`

	// Document conversion settings.
	Conversions *Conversions `json:"conversions,omitempty"`

	// An array of document enrichment settings for the configuration.
	Enrichments []Enrichment `json:"enrichments,omitempty"`

	// Defines operations that can be used to transform the final output JSON into a normalized form. Operations are
	// executed in the order that they appear in the array.
	Normalizations []NormalizationOperation `json:"normalizations,omitempty"`

	// Object containing source parameters for the configuration.
	Source *Source `json:"source,omitempty"`

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

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.
	// =  `cloud_object_storage` indicates the credentials are used to connect to an IBM Cloud Object Store.
	SourceType *string `json:"source_type,omitempty"`

	// Object containing details of the stored credentials.
	//
	// Obtain credentials for your source from the administrator of the source.
	CredentialDetails *CredentialDetails `json:"credential_details,omitempty"`

	// The current status of this set of credentials. `connected` indicates that the credentials are available to use with
	// the source configuration of a collection. `invalid` refers to the credentials (for example, the password provided
	// has expired) and must be corrected before they can be used with a collection.
	Status *string `json:"status,omitempty"`

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

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
}

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
}

type CreateEventResponse struct {

	// The event type that was created.
	Type *string `json:"type,omitempty"`

	// Query event data object.
	Data *EventData `json:"data,omitempty"`
}

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

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

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
}

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 io.ReadCloser `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
}

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
}

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

	// The document ID associated with this training example.
	DocumentID *string `json:"document_id,omitempty"`

	// The cross reference associated with this training example.
	CrossReference *string `json:"cross_reference,omitempty"`

	// The relevance of the training example.
	Relevance *int64 `json:"relevance,omitempty"`

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

type CredentialDetails struct {

	// The authentication method for this credentials definition. The  **credential_type** specified must be supported by
	// the **source_type**. The following combinations are possible:
	//
	// -  `"source_type": "box"` - valid `credential_type`s: `oauth2`
	// -  `"source_type": "salesforce"` - valid `credential_type`s: `username_password`
	// -  `"source_type": "sharepoint"` - valid `credential_type`s: `saml` with **source_version** of `online`, or
	// `ntlm_v1` with **source_version** of `2016`
	// -  `"source_type": "web_crawl"` - valid `credential_type`s: `noauth` or `basic`
	// -  "source_type": "cloud_object_storage"` - valid `credential_type`s: `aws4_hmac`.
	CredentialType *string `json:"credential_type,omitempty"`

	// The **client_id** of the source that these credentials connect to. Only valid, and required, with a
	// **credential_type** of `oauth2`.
	ClientID *string `json:"client_id,omitempty"`

	// The **enterprise_id** of the Box site that these credentials connect to. Only valid, and required, with a
	// **source_type** of `box`.
	EnterpriseID *string `json:"enterprise_id,omitempty"`

	// The **url** of the source that these credentials connect to. Only valid, and required, with a **credential_type** of
	// `username_password`, `noauth`, and `basic`.
	URL *string `json:"url,omitempty"`

	// The **username** of the source that these credentials connect to. Only valid, and required, with a
	// **credential_type** of `saml`, `username_password`, `basic`, or `ntlm_v1`.
	Username *string `json:"username,omitempty"`

	// The **organization_url** of the source that these credentials connect to. Only valid, and required, with a
	// **credential_type** of `saml`.
	OrganizationURL *string `json:"organization_url,omitempty"`

	// The **site_collection.path** of the source that these credentials connect to. Only valid, and required, with a
	// **source_type** of `sharepoint`.
	SiteCollectionPath *string `json:"site_collection.path,omitempty"`

	// The **client_secret** of the source that these credentials connect to. Only valid, and required, with a
	// **credential_type** of `oauth2`. This value is never returned and is only used when creating or modifying
	// **credentials**.
	ClientSecret *string `json:"client_secret,omitempty"`

	// The **public_key_id** of the source that these credentials connect to. Only valid, and required, with a
	// **credential_type** of `oauth2`. This value is never returned and is only used when creating or modifying
	// **credentials**.
	PublicKeyID *string `json:"public_key_id,omitempty"`

	// The **private_key** of the source that these credentials connect to. Only valid, and required, with a
	// **credential_type** of `oauth2`. This value is never returned and is only used when creating or modifying
	// **credentials**.
	PrivateKey *string `json:"private_key,omitempty"`

	// The **passphrase** of the source that these credentials connect to. Only valid, and required, with a
	// **credential_type** of `oauth2`. This value is never returned and is only used when creating or modifying
	// **credentials**.
	Passphrase *string `json:"passphrase,omitempty"`

	// The **password** of the source that these credentials connect to. Only valid, and required, with
	// **credential_type**s of `saml`, `username_password`, `basic`, or `ntlm_v1`.
	//
	// **Note:** When used with a **source_type** of `salesforce`, the password consists of the Salesforce password and a
	// valid Salesforce security token concatenated. This value is never returned and is only used when creating or
	// modifying **credentials**.
	Password *string `json:"password,omitempty"`

	// The ID of the **gateway** to be connected through (when connecting to intranet sites). Only valid with a
	// **credential_type** of `noauth`, `basic`, or `ntlm_v1`. Gateways are created using the
	// `/v1/environments/{environment_id}/gateways` methods.
	GatewayID *string `json:"gateway_id,omitempty"`

	// The type of Sharepoint repository to connect to. Only valid, and required, with a **source_type** of `sharepoint`.
	SourceVersion *string `json:"source_version,omitempty"`

	// SharePoint OnPrem WebApplication URL. Only valid, and required, with a **source_version** of `2016`. If a port is
	// not supplied, the default to port `80` for http and port `443` for https connections are used.
	WebApplicationURL *string `json:"web_application_url,omitempty"`

	// The domain used to log in to your OnPrem SharePoint account. Only valid, and required, with a **source_version** of
	// `2016`.
	Domain *string `json:"domain,omitempty"`

	// The endpoint associated with the cloud object store that your are connecting to. Only valid, and required, with a
	// **credential_type** of `aws4_hmac`.
	Endpoint *string `json:"endpoint,omitempty"`

	// The access key ID associated with the cloud object store. Only valid, and required, with a **credential_type** of
	// `aws4_hmac`. This value is never returned and is only used when creating or modifying **credentials**. For more
	// infomation, see the [cloud object store
	// documentation](https://cloud.ibm.com/docs/services/cloud-object-storage?topic=cloud-object-storage-using-hmac-credentials#using-hmac-credentials).
	AccessKeyID *string `json:"access_key_id,omitempty"`

	// The secret access key associated with the cloud object store. Only valid, and required, with a **credential_type**
	// of `aws4_hmac`. This value is never returned and is only used when creating or modifying **credentials**. For more
	// infomation, see the [cloud object store
	// documentation](https://cloud.ibm.com/docs/services/cloud-object-storage?topic=cloud-object-storage-using-hmac-credentials#using-hmac-credentials).
	SecretAccessKey *string `json:"secret_access_key,omitempty"`
}

type Credentials struct {

	// Unique identifier for this set of credentials.
	CredentialID *string `json:"credential_id,omitempty"`

	// The source that this credentials object connects to.
	// -  `box` indicates the credentials are used to connect an instance of Enterprise Box.
	// -  `salesforce` indicates the credentials are used to connect to Salesforce.
	// -  `sharepoint` indicates the credentials are used to connect to Microsoft SharePoint Online.
	// -  `web_crawl` indicates the credentials are used to perform a web crawl.
	// =  `cloud_object_storage` indicates the credentials are used to connect to an IBM Cloud Object Store.
	SourceType *string `json:"source_type,omitempty"`

	// Object containing details of the stored credentials.
	//
	// Obtain credentials for your source from the administrator of the source.
	CredentialDetails *CredentialDetails `json:"credential_details,omitempty"`

	// The current status of this set of credentials. `connected` indicates that the credentials are available to use with
	// the source configuration of a collection. `invalid` refers to the credentials (for example, the password provided
	// has expired) and must be corrected before they can be used with a collection.
	Status *string `json:"status,omitempty"`
}

type CredentialsList struct {

	// An array of credential definitions that were created for this instance.
	Credentials []Credentials `json:"credentials,omitempty"`
}

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
}

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
}

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

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
}

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

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

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
}

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
}

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

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
}

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

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
}

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
}

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
}

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
}

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
}

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
}

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
}

type DiscoveryV1 struct {
	Service *core.BaseService
	Version string
}

type DiscoveryV1Options struct {
	URL           string
	Authenticator core.Authenticator
	Version       string
}

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

type DocumentAccepted struct {

	// The unique identifier of the ingested document.
	DocumentID *string `json:"document_id,omitempty"`

	// Status of the document in the ingestion process. A status of `processing` is returned for documents that are
	// ingested with a *version* date before `2019-01-01`. The `pending` status is returned for all others.
	Status *string `json:"status,omitempty"`

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

type DocumentCounts struct {

	// The total number of available documents in the collection.
	Available *int64 `json:"available,omitempty"`

	// The number of documents in the collection that are currently being processed.
	Processing *int64 `json:"processing,omitempty"`

	// The number of documents in the collection that failed to be ingested.
	Failed *int64 `json:"failed,omitempty"`

	// The number of documents that have been uploaded to the collection, but have not yet started processing.
	Pending *int64 `json:"pending,omitempty"`
}

type DocumentStatus struct {

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

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

	// Status of the document in the ingestion process.
	Status *string `json:"status" validate:"required"`

	// Description of the document status.
	StatusDescription *string `json:"status_description" validate:"required"`

	// Name of the original source file (if available).
	Filename *string `json:"filename,omitempty"`

	// The type of the original source file.
	FileType *string `json:"file_type,omitempty"`

	// The SHA-1 hash of the original source file (formatted as a hexadecimal string).
	Sha1 *string `json:"sha1,omitempty"`

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

type Enrichment struct {

	// Describes what the enrichment step does.
	Description *string `json:"description,omitempty"`

	// Field where enrichments will be stored. This field must already exist or be at most 1 level deeper than an existing
	// field. For example, if `text` is a top-level field with no sub-fields, `text.foo` is a valid destination but
	// `text.foo.bar` is not.
	DestinationField *string `json:"destination_field" validate:"required"`

	// Field to be enriched.
	//
	// Arrays can be specified as the **source_field** if the **enrichment** service for this enrichment is set to
	// `natural_language_undstanding`.
	SourceField *string `json:"source_field" validate:"required"`

	// Indicates that the enrichments will overwrite the destination_field field if it already exists.
	Overwrite *bool `json:"overwrite,omitempty"`

	// Name of the enrichment service to call. Current options are `natural_language_understanding` and `elements`.
	//
	//  When using `natual_language_understanding`, the **options** object must contain Natural Language Understanding
	// options.
	//
	//  When using `elements` the **options** object must contain Element Classification options. Additionally, when using
	// the `elements` enrichment the configuration specified and files ingested must meet all the criteria specified in
	// [the
	// documentation](https://cloud.ibm.com/docs/services/discovery?topic=discovery-element-classification#element-classification).
	Enrichment *string `json:"enrichment" validate:"required"`

	// If true, then most errors generated during the enrichment process will be treated as warnings and will not cause the
	// document to fail processing.
	IgnoreDownstreamErrors *bool `json:"ignore_downstream_errors,omitempty"`

	// Options which are specific to a particular enrichment.
	Options *EnrichmentOptions `json:"options,omitempty"`
}

type EnrichmentOptions struct {

	// Object containing Natural Language Understanding features to be used.
	Features *NluEnrichmentFeatures `json:"features,omitempty"`

	// ISO 639-1 code indicating the language to use for the analysis. This code overrides the automatic language detection
	// performed by the service. Valid codes are `ar` (Arabic), `en` (English), `fr` (French), `de` (German), `it`
	// (Italian), `pt` (Portuguese), `ru` (Russian), `es` (Spanish), and `sv` (Swedish). **Note:** Not all features support
	// all languages, automatic detection is recommended.
	Language *string `json:"language,omitempty"`

	// *For use with `elements` enrichments only.* The element extraction model to use. Models available are: `contract`.
	Model *string `json:"model,omitempty"`
}

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

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

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

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

type Expansions struct {

	// An array of query expansion definitions.
	//
	//  Each object in the **expansions** array represents a term or set of terms that will be expanded into other terms.
	// Each expansion object can be configured as bidirectional or unidirectional. Bidirectional means that all terms are
	// expanded to all other terms in the object. Unidirectional means that a set list of terms can be expanded into a
	// second list of terms.
	//
	//  To create a bi-directional expansion specify an **expanded_terms** array. When found in a query, all items in the
	// **expanded_terms** array are then expanded to the other items in the same array.
	//
	//  To create a uni-directional expansion, specify both an array of **input_terms** and an array of **expanded_terms**.
	// When items in the **input_terms** array are present in a query, they are expanded using the items listed in the
	// **expanded_terms** array.
	Expansions []Expansion `json:"expansions" validate:"required"`
}

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.
	Query *string `json:"query,omitempty"`

	// A natural language query that returns relevant documents by utilizing training data and natural language
	// understanding.
	NaturalLanguageQuery *string `json:"natural_language_query,omitempty"`

	// 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. The maximum for the **count** and **offset** values together in any one query is
	// **10000**.
	Count *int64 `json:"count,omitempty"`

	// A comma-separated list of the portion of the document hierarchy to return.
	Return []string `json:"return,omitempty"`

	// The number of query results to skip at the beginning. For example, if the total number of results that are returned
	// is 10 and the offset is 8, it returns the last two results. The maximum for the **count** and **offset** values
	// together in any one query is **10000**.
	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
}

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.
	Query *string `json:"query,omitempty"`

	// A natural language query that returns relevant documents by utilizing training data and natural language
	// understanding.
	NaturalLanguageQuery *string `json:"natural_language_query,omitempty"`

	// A passages query that returns the most relevant passages from the results.
	Passages *bool `json:"passages,omitempty"`

	// An aggregation search that returns an exact answer by combining query search with filters. Useful for applications
	// to build lists, tables, and time series. For a full list of possible aggregations, see the Query reference.
	Aggregation *string `json:"aggregation,omitempty"`

	// Number of results to return.
	Count *int64 `json:"count,omitempty"`

	// A comma-separated list of the portion of the document hierarchy to return.
	Return *string `json:"return,omitempty"`

	// The number of query results to skip at the beginning. For example, if the total number of results that are returned
	// is 10 and the offset is 8, it returns the last two results.
	Offset *int64 `json:"offset,omitempty"`

	// A comma-separated list of fields in the document to sort on. You can optionally specify a sort direction by
	// prefixing the field with `-` for descending or `+` for ascending. Ascending is the default sort direction if no
	// prefix is specified. This parameter cannot be used in the same query as the **bias** parameter.
	Sort *string `json:"sort,omitempty"`

	// When true, a highlight field is returned for each result which contains the fields which match the query with
	// `<em></em>` tags around the matching query terms.
	Highlight *bool `json:"highlight,omitempty"`

	// A comma-separated list of fields that passages are drawn from. If this parameter not specified, then all top-level
	// fields are included.
	PassagesFields *string `json:"passages.fields,omitempty"`

	// The maximum number of passages to return. The search returns fewer passages if the requested total is not found. The
	// default is `10`. The maximum is `100`.
	PassagesCount *int64 `json:"passages.count,omitempty"`

	// The approximate number of characters that any one passage will have.
	PassagesCharacters *int64 `json:"passages.characters,omitempty"`

	// When `true`, and used with a Watson Discovery News collection, duplicate results (based on the contents of the
	// **title** field) are removed. Duplicate comparison is limited to the current query only; **offset** is not
	// considered. This parameter is currently Beta functionality.
	Deduplicate *bool `json:"deduplicate,omitempty"`

	// When specified, duplicate results based on the field specified are removed from the returned results. Duplicate
	// comparison is limited to the current query only, **offset** is not considered. This parameter is currently Beta
	// functionality.
	DeduplicateField *string `json:"deduplicate.field,omitempty"`

	// When `true`, results are returned based on their similarity to the document IDs specified in the
	// **similar.document_ids** parameter.
	Similar *bool `json:"similar,omitempty"`

	// A comma-separated list of document IDs to find similar documents.
	//
	// **Tip:** Include the **natural_language_query** parameter to expand the scope of the document similarity search with
	// the natural language query. Other query parameters, such as **filter** and **query**, are subsequently applied and
	// reduce the scope.
	SimilarDocumentIds *string `json:"similar.document_ids,omitempty"`

	// A comma-separated list of field names that are used as a basis for comparison to identify similar documents. If not
	// specified, the entire document is used for comparison.
	SimilarFields *string `json:"similar.fields,omitempty"`

	// Field which the returned results will be biased against. The specified field must be either a **date** or **number**
	// format. When a **date** type field is specified returned results are biased towards field values closer to the
	// current date. When a **number** type field is specified, returned results are biased towards higher field values.
	// This parameter cannot be used in the same query as the **sort** parameter.
	Bias *string `json:"bias,omitempty"`

	// A comma-separated list of collection IDs to be queried against.
	CollectionIds *string `json:"collection_ids,omitempty"`

	// If `true`, queries are not stored in the Discovery **Logs** endpoint.
	XWatsonLoggingOptOut *bool `json:"X-Watson-Logging-Opt-Out,omitempty"`

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

type Field struct {

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

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

type Filter struct {

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

type FontSetting struct {

	// The HTML heading level that any content with the matching font is converted to.
	Level *int64 `json:"level,omitempty"`

	// The minimum size of the font to match.
	MinSize *int64 `json:"min_size,omitempty"`

	// The maximum size of the font to match.
	MaxSize *int64 `json:"max_size,omitempty"`

	// When `true`, the font is matched if it is bold.
	Bold *bool `json:"bold,omitempty"`

	// When `true`, the font is matched if it is italic.
	Italic *bool `json:"italic,omitempty"`

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

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

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

type GatewayList struct {

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

type GetAutocompletionOptions 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 prefix to use for autocompletion. For example, the prefix `Ho` could autocomplete to `Hot`, `Housing`, or `How
	// do I upgrade`. Possible completions are.
	Prefix *string `json:"prefix" validate:"required"`

	// The field in the result documents that autocompletion suggestions are identified from.
	Field *string `json:"field,omitempty"`

	// The number of autocompletion suggestions to return.
	Count *int64 `json:"count,omitempty"`

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

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

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
}

type GetMetricsQueryTokenEventOptions struct {

	// Number of results to return. The maximum for the **count** and **offset** values together in any one query is
	// **10000**.
	Count *int64 `json:"count,omitempty"`

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

type GetStopwordListStatusOptions 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
}

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
}

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
}