discoveryv2

type AddDocumentOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_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"`

	// When `true`, the uploaded document is added to the collection even if the data for that collection is shared with
	// other collections.
	XWatsonDiscoveryForce *bool `json:"X-Watson-Discovery-Force,omitempty"`

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

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

type CollectionDetails struct {

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

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

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

	// The date that the collection was created.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The language of the collection.
	Language *string `json:"language,omitempty"`

	// An array of enrichments that are applied to this collection.
	Enrichments []CollectionEnrichment `json:"enrichments,omitempty"`
}

type CollectionEnrichment struct {

	// The unique identifier of this enrichment.
	EnrichmentID *string `json:"enrichment_id,omitempty"`

	// An array of field names that the enrichment is applied to.
	Fields []string `json:"fields,omitempty"`
}

type Completions struct {

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

type ComponentSettingsAggregation struct {

	// Identifier used to map aggregation settings to aggregation configuration.
	Name *string `json:"name,omitempty"`

	// User-friendly alias for the aggregation.
	Label *string `json:"label,omitempty"`

	// Whether users is allowed to select more than one of the aggregation terms.
	MultipleSelectionsAllowed *bool `json:"multiple_selections_allowed,omitempty"`

	// Type of visualization to use when rendering the aggregation.
	VisualizationType *string `json:"visualization_type,omitempty"`
}

type ComponentSettingsFieldsShown struct {

	// Body label.
	Body *ComponentSettingsFieldsShownBody `json:"body,omitempty"`

	// Title label.
	Title *ComponentSettingsFieldsShownTitle `json:"title,omitempty"`
}

type ComponentSettingsFieldsShownBody struct {

	// Use the whole passage as the body.
	UsePassage *bool `json:"use_passage,omitempty"`

	// Use a specific field as the title.
	Field *string `json:"field,omitempty"`
}

type ComponentSettingsFieldsShownTitle struct {

	// Use a specific field as the title.
	Field *string `json:"field,omitempty"`
}

type ComponentSettingsResponse struct {

	// Fields shown in the results section of the UI.
	FieldsShown *ComponentSettingsFieldsShown `json:"fields_shown,omitempty"`

	// Whether or not autocomplete is enabled.
	Autocomplete *bool `json:"autocomplete,omitempty"`

	// Whether or not structured search is enabled.
	StructuredSearch *bool `json:"structured_search,omitempty"`

	// Number or results shown per page.
	ResultsPerPage *int64 `json:"results_per_page,omitempty"`

	// a list of component setting aggregations.
	Aggregations []ComponentSettingsAggregation `json:"aggregations,omitempty"`
}

type CreateCollectionOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

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

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

	// The language of the collection.
	Language *string `json:"language,omitempty"`

	// An array of enrichments that are applied to this collection.
	Enrichments []CollectionEnrichment `json:"enrichments,omitempty"`

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

type CreateEnrichment struct {

	// The human readable name for this enrichment.
	Name *string `json:"name,omitempty"`

	// The description of this enrichment.
	Description *string `json:"description,omitempty"`

	// The type of this enrichment.
	Type *string `json:"type,omitempty"`

	// A object containing options for the current enrichment.
	Options *EnrichmentOptions `json:"options,omitempty"`
}

type CreateEnrichmentOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

	// Information about a specific enrichment.
	Enrichment *CreateEnrichment `json:"enrichment" validate:"required"`

	// The enrichment file to upload.
	File io.ReadCloser `json:"file,omitempty"`

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

type CreateProjectOptions struct {

	// The human readable name of this project.
	Name *string `json:"name" validate:"required"`

	// The project type of this project.
	Type *string `json:"type" validate:"required"`

	// Default query parameters for this project.
	DefaultQueryParameters *DefaultQueryParams `json:"default_query_parameters,omitempty"`

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

type CreateTrainingQueryOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

	// The natural text query for the training query.
	NaturalLanguageQuery *string `json:"natural_language_query" validate:"required"`

	// Array of training examples.
	Examples []TrainingExample `json:"examples" validate:"required"`

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

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

type DefaultQueryParams struct {

	// An array of collection identifiers to query. If empty or omitted all collections in the project are queried.
	CollectionIds []string `json:"collection_ids,omitempty"`

	// Default settings configuration for passage search options.
	Passages *DefaultQueryParamsPassages `json:"passages,omitempty"`

	// Default project query settings for table results.
	TableResults *DefaultQueryParamsTableResults `json:"table_results,omitempty"`

	// A string representing the default aggregation query for the project.
	Aggregation *string `json:"aggregation,omitempty"`

	// Object containing suggested refinement settings.
	SuggestedRefinements *DefaultQueryParamsSuggestedRefinements `json:"suggested_refinements,omitempty"`

	// When `true`, a spelling suggestions for the query are retuned by default.
	SpellingSuggestions *bool `json:"spelling_suggestions,omitempty"`

	// When `true`, a highlights for the query are retuned by default.
	Highlight *bool `json:"highlight,omitempty"`

	// The number of document results returned by default.
	Count *int64 `json:"count,omitempty"`

	// A comma separated list of document fields to sort results by default.
	Sort *string `json:"sort,omitempty"`

	// An array of field names to return in document results if present by default.
	Return []string `json:"return,omitempty"`
}

type DefaultQueryParamsPassages struct {

	// When `true`, a passage search is performed by default.
	Enabled *bool `json:"enabled,omitempty"`

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

	// An array of field names to perfom the passage search on.
	Fields []string `json:"fields,omitempty"`

	// The approximate number of characters that each returned passage will contain.
	Characters *int64 `json:"characters,omitempty"`

	// When `true` the number of passages that can be returned from a single document is restricted to the
	// *max_per_document* value.
	PerDocument *bool `json:"per_document,omitempty"`

	// The default maximum number of passages that can be taken from a single document as the result of a passage query.
	MaxPerDocument *int64 `json:"max_per_document,omitempty"`
}

type DefaultQueryParamsSuggestedRefinements struct {

	// When `true`, a suggested refinements for the query are retuned by default.
	Enabled *bool `json:"enabled,omitempty"`

	// The number of suggested refinements to return by default.
	Count *int64 `json:"count,omitempty"`
}

type DefaultQueryParamsTableResults struct {

	// When `true`, a table results for the query are retuned by default.
	Enabled *bool `json:"enabled,omitempty"`

	// The number of table results to return by default.
	Count *int64 `json:"count,omitempty"`

	// The number of table results to include in each result document.
	PerDocument *int64 `json:"per_document,omitempty"`
}

type DeleteCollectionOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_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 DeleteDocumentOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_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"`

	// When `true`, the uploaded document is added to the collection even if the data for that collection is shared with
	// other collections.
	XWatsonDiscoveryForce *bool `json:"X-Watson-Discovery-Force,omitempty"`

	// 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 DeleteEnrichmentOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

	// The ID of the enrichment.
	EnrichmentID *string `json:"enrichment_id" validate:"required"`

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

type DeleteProjectOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

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

type DeleteTrainingQueriesOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_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 DiscoveryV2 struct {
	Service *core.BaseService
	Version string
}

type DiscoveryV2Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
	Version       string
}

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

type DocumentAttribute struct {

	// The type of attribute.
	Type *string `json:"type,omitempty"`

	// The text associated with the attribute.
	Text *string `json:"text,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *TableElementLocation `json:"location,omitempty"`
}

type Enrichment struct {

	// The unique identifier of this enrichment.
	EnrichmentID *string `json:"enrichment_id,omitempty"`

	// The human readable name for this enrichment.
	Name *string `json:"name,omitempty"`

	// The description of this enrichment.
	Description *string `json:"description,omitempty"`

	// The type of this enrichment.
	Type *string `json:"type,omitempty"`

	// A object containing options for the current enrichment.
	Options *EnrichmentOptions `json:"options,omitempty"`
}

type EnrichmentOptions struct {

	// An array of supported languages for this enrichment.
	Languages []string `json:"languages,omitempty"`

	// The type of entity. Required when creating `dictionary` and `regular_expression` **type** enrichment. Not valid when
	// creating any other type of enrichment.
	EntityType *string `json:"entity_type,omitempty"`

	// The regular expression to apply for this enrichment. Required only when the **type** of enrichment being created is
	// a `regular_expression`. Not valid when creating any other type of enrichment.
	RegularExpression *string `json:"regular_expression,omitempty"`

	// The name of the result document field that this enrichment creates. Required only when the enrichment **type** is
	// `rule_based`. Not valid when creating any other type of enrichment.
	ResultField *string `json:"result_field,omitempty"`
}

type Enrichments struct {

	// An array of enrichment definitions.
	Enrichments []Enrichment `json:"enrichments,omitempty"`
}

type Field struct {

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

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

	// The collection Id of the collection where the field was found.
	CollectionID *string `json:"collection_id,omitempty"`
}

type GetAutocompletionOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_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"`

	// Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are
	// used.
	CollectionIds []string `json:"collection_ids,omitempty"`

	// 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 project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_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 GetComponentSettingsOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

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

type GetEnrichmentOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

	// The ID of the enrichment.
	EnrichmentID *string `json:"enrichment_id" validate:"required"`

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

type GetProjectOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

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

type GetTrainingQueryOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_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 ListCollectionsOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

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

type ListCollectionsResponse struct {

	// An array containing information about each collection in the project.
	Collections []Collection `json:"collections,omitempty"`
}

type ListEnrichmentsOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

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

type ListFieldsOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

	// Comma separated list of the collection IDs. If this parameter is not specified, all collections in the project are
	// used.
	CollectionIds []string `json:"collection_ids,omitempty"`

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

type ListFieldsResponse struct {

	// An array containing information about each field in the collections.
	Fields []Field `json:"fields,omitempty"`
}

type ListProjectsOptions struct {

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

type ListProjectsResponse struct {

	// An array of project details.
	Projects []ProjectListDetails `json:"projects,omitempty"`
}

type ListTrainingQueriesOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

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

type Notice struct {

	// Identifies the notice. Many notices might have the same ID. This field exists so that user applications can
	// programmatically identify a notice and take automatic corrective action. Typical notice IDs include: `index_failed`,
	// `index_failed_too_many_requests`, `index_failed_incompatible_field`, `index_failed_cluster_unavailable`,
	// `ingestion_timeout`, `ingestion_error`, `bad_request`, `internal_error`, `missing_model`, `unsupported_model`,
	// `smart_document_understanding_failed_incompatible_field`, `smart_document_understanding_failed_internal_error`,
	// `smart_document_understanding_failed_internal_error`, `smart_document_understanding_failed_warning`,
	// `smart_document_understanding_page_error`, `smart_document_understanding_page_warning`. **Note:** This is not a
	// complete list, other values might be returned.
	NoticeID *string `json:"notice_id,omitempty"`

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

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

	// Unique identifier of the collection.
	CollectionID *string `json:"collection_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"`
}

type ProjectDetails struct {

	// The unique identifier of this project.
	ProjectID *string `json:"project_id,omitempty"`

	// The human readable name of this project.
	Name *string `json:"name,omitempty"`

	// The project type of this project.
	Type *string `json:"type,omitempty"`

	// Relevancy training status information for this project.
	RelevancyTrainingStatus *ProjectListDetailsRelevancyTrainingStatus `json:"relevancy_training_status,omitempty"`

	// The number of collections configured in this project.
	CollectionCount *int64 `json:"collection_count,omitempty"`

	// Default query parameters for this project.
	DefaultQueryParameters *DefaultQueryParams `json:"default_query_parameters,omitempty"`
}

type ProjectListDetails struct {

	// The unique identifier of this project.
	ProjectID *string `json:"project_id,omitempty"`

	// The human readable name of this project.
	Name *string `json:"name,omitempty"`

	// The project type of this project.
	Type *string `json:"type,omitempty"`

	// Relevancy training status information for this project.
	RelevancyTrainingStatus *ProjectListDetailsRelevancyTrainingStatus `json:"relevancy_training_status,omitempty"`

	// The number of collections configured in this project.
	CollectionCount *int64 `json:"collection_count,omitempty"`
}

type ProjectListDetailsRelevancyTrainingStatus struct {

	// When the training data was updated.
	DataUpdated *string `json:"data_updated,omitempty"`

	// The total number of examples.
	TotalExamples *int64 `json:"total_examples,omitempty"`

	// When `true`, sufficent label diversity is present to allow training for this project.
	SufficientLabelDiversity *bool `json:"sufficient_label_diversity,omitempty"`

	// When `true`, the relevancy training is in processing.
	Processing *bool `json:"processing,omitempty"`

	// When `true`, the minimum number of examples required to train has been met.
	MinimumExamplesAdded *bool `json:"minimum_examples_added,omitempty"`

	// The time that the most recent successful training occured.
	SuccessfullyTrained *string `json:"successfully_trained,omitempty"`

	// When `true`, relevancy training is available when querying collections in the project.
	Available *bool `json:"available,omitempty"`

	// The number of notices generated during the relevancy training.
	Notices *int64 `json:"notices,omitempty"`

	// When `true`, the minimum number of queries required to train has been met.
	MinimumQueriesAdded *bool `json:"minimum_queries_added,omitempty"`
}

type QueryAggregation struct {

	// The type of aggregation command used. Options include: term, histogram, timeslice, nested, filter, min, max, sum,
	// average, unique_count, and top_hits.
	Type *string `json:"type" validate:"required"`
}

type QueryCalculationAggregation struct {

	// The field to perform the calculation on.
	Field *string `json:"field" validate:"required"`

	// The value of the calculation.
	Value *float64 `json:"value,omitempty"`
}

type QueryFilterAggregation struct {

	// The filter written in Discovery Query Language syntax applied to the documents before sub aggregations are run.
	Match *string `json:"match" validate:"required"`

	// Number of documents matching the filter.
	MatchingResults *int64 `json:"matching_results" validate:"required"`

	// An array of sub aggregations.
	Aggregations []QueryAggregation `json:"aggregations,omitempty"`
}

type QueryGroupByAggregation struct {

	// Array of top values for the field.
	Results []QueryGroupByAggregationResult `json:"results,omitempty"`
}

type QueryGroupByAggregationResult struct {

	// Value of the field with a non-zero frequency in the document set.
	Key *string `json:"key" validate:"required"`

	// Number of documents containing the 'key'.
	MatchingResults *int64 `json:"matching_results" validate:"required"`

	// The relevancy for this group.
	Relevancy *float64 `json:"relevancy,omitempty"`

	// The number of documents which have the group as the value of specified field in the whole set of documents in this
	// collection. Returned only when the `relevancy` parameter is set to `true`.
	TotalMatchingDocuments *int64 `json:"total_matching_documents,omitempty"`

	// The estimated number of documents which would match the query and also meet the condition. Returned only when the
	// `relevancy` parameter is set to `true`.
	EstimatedMatchingDocuments *int64 `json:"estimated_matching_documents,omitempty"`

	// An array of sub aggregations.
	Aggregations []QueryAggregation `json:"aggregations,omitempty"`
}

type QueryHistogramAggregation struct {

	// The numeric field name used to create the histogram.
	Field *string `json:"field" validate:"required"`

	// The size of the sections the results are split into.
	Interval *int64 `json:"interval" validate:"required"`

	// Identifier specified in the query request of this aggregation.
	Name *string `json:"name,omitempty"`

	// Array of numeric intervals.
	Results []QueryHistogramAggregationResult `json:"results,omitempty"`
}

type QueryHistogramAggregationResult struct {

	// The value of the upper bound for the numeric segment.
	Key *int64 `json:"key" validate:"required"`

	// Number of documents with the specified key as the upper bound.
	MatchingResults *int64 `json:"matching_results" validate:"required"`

	// An array of sub aggregations.
	Aggregations []QueryAggregation `json:"aggregations,omitempty"`
}

type QueryLargePassages struct {

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

	// When `true`, passages will be returned within their respective result.
	PerDocument *bool `json:"per_document,omitempty"`

	// Maximum number of passages to return per result.
	MaxPerDocument *int64 `json:"max_per_document,omitempty"`

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

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

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

type QueryLargeSuggestedRefinements struct {

	// Whether to perform suggested refinements.
	Enabled *bool `json:"enabled,omitempty"`

	// Maximum number of suggested refinements texts to be returned. The maximum is `100`.
	Count *int64 `json:"count,omitempty"`
}

type QueryLargeTableResults struct {

	// Whether to enable table retrieval.
	Enabled *bool `json:"enabled,omitempty"`

	// Maximum number of tables to return.
	Count *int64 `json:"count,omitempty"`
}

type QueryNestedAggregation struct {

	// The path to the document field to scope sub aggregations to.
	Path *string `json:"path" validate:"required"`

	// Number of nested documents found in the specified field.
	MatchingResults *int64 `json:"matching_results" validate:"required"`

	// An array of sub aggregations.
	Aggregations []QueryAggregation `json:"aggregations,omitempty"`
}

type QueryNoticesOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_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.
	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"`

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

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

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

type QueryNoticesResponse struct {

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

	// Array of document results that match the query.
	Notices []Notice `json:"notices,omitempty"`
}

type QueryOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

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

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

	// 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 list of the fields in the document hierarchy to return. If this parameter not specified, then all top-level fields
	// are returned.
	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"`

	// When `true` and the **natural_language_query** parameter is used, the **natural_language_query** parameter is spell
	// checked. The most likely correction is returned in the **suggested_query** field of the response (if one exists).
	SpellingSuggestions *bool `json:"spelling_suggestions,omitempty"`

	// Configuration for table retrieval.
	TableResults *QueryLargeTableResults `json:"table_results,omitempty"`

	// Configuration for suggested refinements.
	SuggestedRefinements *QueryLargeSuggestedRefinements `json:"suggested_refinements,omitempty"`

	// Configuration for passage retrieval.
	Passages *QueryLargePassages `json:"passages,omitempty"`

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

type QueryResponse struct {

	// The number of matching results for the query.
	MatchingResults *int64 `json:"matching_results,omitempty"`

	// Array of document results for the query.
	Results []QueryResult `json:"results,omitempty"`

	// Array of aggregations for the query.
	Aggregations []QueryAggregation `json:"aggregations,omitempty"`

	// An object contain retrieval type information.
	RetrievalDetails *RetrievalDetails `json:"retrieval_details,omitempty"`

	// Suggested correction to the submitted **natural_language_query** value.
	SuggestedQuery *string `json:"suggested_query,omitempty"`

	// Array of suggested refinements.
	SuggestedRefinements []QuerySuggestedRefinement `json:"suggested_refinements,omitempty"`

	// Array of table results.
	TableResults []QueryTableResult `json:"table_results,omitempty"`
}

type QueryResult map[string]interface{}

type QueryResultMetadata struct {

	// The document retrieval source that produced this search result.
	DocumentRetrievalSource *string `json:"document_retrieval_source,omitempty"`

	// The collection id associated with this training data set.
	CollectionID *string `json:"collection_id" 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. This field is only returned if the **natural_language_query** parameter is specified in the query.
	Confidence *float64 `json:"confidence,omitempty"`
}

type QueryResultPassage struct {

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

type QuerySuggestedRefinement struct {

	// The text used to filter.
	Text *string `json:"text,omitempty"`
}

type QueryTableResult struct {

	// The identifier for the retrieved table.
	TableID *string `json:"table_id,omitempty"`

	// The identifier of the document the table was retrieved from.
	SourceDocumentID *string `json:"source_document_id,omitempty"`

	// The identifier of the collection the table was retrieved from.
	CollectionID *string `json:"collection_id,omitempty"`

	// HTML snippet of the table info.
	TableHTML *string `json:"table_html,omitempty"`

	// The offset of the table html snippet in the original document html.
	TableHTMLOffset *int64 `json:"table_html_offset,omitempty"`

	// Full table object retrieved from Table Understanding Enrichment.
	Table *TableResultTable `json:"table,omitempty"`
}

type QueryTermAggregation struct {

	// The field in the document used to generate top values from.
	Field *string `json:"field" validate:"required"`

	// The number of top values returned.
	Count *int64 `json:"count,omitempty"`

	// Identifier specified in the query request of this aggregation.
	Name *string `json:"name,omitempty"`

	// Array of top values for the field.
	Results []QueryTermAggregationResult `json:"results,omitempty"`
}

type QueryTermAggregationResult struct {

	// Value of the field with a non-zero frequency in the document set.
	Key *string `json:"key" validate:"required"`

	// Number of documents containing the 'key'.
	MatchingResults *int64 `json:"matching_results" validate:"required"`

	// The relevancy for this term.
	Relevancy *float64 `json:"relevancy,omitempty"`

	// The number of documents which have the term as the value of specified field in the whole set of documents in this
	// collection. Returned only when the `relevancy` parameter is set to `true`.
	TotalMatchingDocuments *int64 `json:"total_matching_documents,omitempty"`

	// The estimated number of documents which would match the query and also meet the condition. Returned only when the
	// `relevancy` parameter is set to `true`.
	EstimatedMatchingDocuments *int64 `json:"estimated_matching_documents,omitempty"`

	// An array of sub aggregations.
	Aggregations []QueryAggregation `json:"aggregations,omitempty"`
}

type QueryTimesliceAggregation struct {

	// The date field name used to create the timeslice.
	Field *string `json:"field" validate:"required"`

	// The date interval value. Valid values are seconds, minutes, hours, days, weeks, and years.
	Interval *string `json:"interval" validate:"required"`

	// Identifier specified in the query request of this aggregation.
	Name *string `json:"name,omitempty"`

	// Array of aggregation results.
	Results []QueryTimesliceAggregationResult `json:"results,omitempty"`
}

type QueryTimesliceAggregationResult struct {

	// String date value of the upper bound for the timeslice interval in ISO-8601 format.
	KeyAsString *string `json:"key_as_string" validate:"required"`

	// Numeric date value of the upper bound for the timeslice interval in UNIX milliseconds since epoch.
	Key *int64 `json:"key" validate:"required"`

	// Number of documents with the specified key as the upper bound.
	MatchingResults *int64 `json:"matching_results" validate:"required"`

	// An array of sub aggregations.
	Aggregations []QueryAggregation `json:"aggregations,omitempty"`
}

type QueryTopHitsAggregation struct {

	// The number of documents to return.
	Size *int64 `json:"size" validate:"required"`

	// Identifier specified in the query request of this aggregation.
	Name *string `json:"name,omitempty"`

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

type QueryTopHitsAggregationResult struct {

	// Number of matching results.
	MatchingResults *int64 `json:"matching_results" validate:"required"`

	// An array of the document results.
	Hits []map[string]interface{} `json:"hits,omitempty"`
}

type RetrievalDetails struct {

	// Identifies the document retrieval strategy used for this query. `relevancy_training` indicates that the results were
	// returned using a relevancy trained 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"`
}

type TableBodyCells struct {

	// The unique ID of the cell in the current table.
	CellID *string `json:"cell_id,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *TableElementLocation `json:"location,omitempty"`

	// The textual contents of this cell from the input document without associated markup content.
	Text *string `json:"text,omitempty"`

	// The `begin` index of this cell's `row` location in the current table.
	RowIndexBegin *int64 `json:"row_index_begin,omitempty"`

	// The `end` index of this cell's `row` location in the current table.
	RowIndexEnd *int64 `json:"row_index_end,omitempty"`

	// The `begin` index of this cell's `column` location in the current table.
	ColumnIndexBegin *int64 `json:"column_index_begin,omitempty"`

	// The `end` index of this cell's `column` location in the current table.
	ColumnIndexEnd *int64 `json:"column_index_end,omitempty"`

	// A list of table row header ids.
	RowHeaderIds []TableRowHeaderIds `json:"row_header_ids,omitempty"`

	// A list of table row header texts.
	RowHeaderTexts []TableRowHeaderTexts `json:"row_header_texts,omitempty"`

	// A list of table row header texts normalized.
	RowHeaderTextsNormalized []TableRowHeaderTextsNormalized `json:"row_header_texts_normalized,omitempty"`

	// A list of table column header ids.
	ColumnHeaderIds []TableColumnHeaderIds `json:"column_header_ids,omitempty"`

	// A list of table column header texts.
	ColumnHeaderTexts []TableColumnHeaderTexts `json:"column_header_texts,omitempty"`

	// A list of table column header texts normalized.
	ColumnHeaderTextsNormalized []TableColumnHeaderTextsNormalized `json:"column_header_texts_normalized,omitempty"`

	// A list of document attributes.
	Attributes []DocumentAttribute `json:"attributes,omitempty"`
}

type TableCellKey struct {

	// The unique ID of the key in the table.
	CellID *string `json:"cell_id,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *TableElementLocation `json:"location,omitempty"`

	// The text content of the table cell without HTML markup.
	Text *string `json:"text,omitempty"`
}

type TableCellValues struct {

	// The unique ID of the value in the table.
	CellID *string `json:"cell_id,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *TableElementLocation `json:"location,omitempty"`

	// The text content of the table cell without HTML markup.
	Text *string `json:"text,omitempty"`
}

type TableColumnHeaderIds struct {

	// The `id` value of a column header.
	ID *string `json:"id,omitempty"`
}

type TableColumnHeaderTexts struct {

	// The `text` value of a column header.
	Text *string `json:"text,omitempty"`
}

type TableColumnHeaderTextsNormalized struct {

	// The normalized version of a column header text.
	TextNormalized *string `json:"text_normalized,omitempty"`
}

type TableColumnHeaders struct {

	// The unique ID of the cell in the current table.
	CellID *string `json:"cell_id,omitempty"`

	// The location of the column header cell in the current table as defined by its `begin` and `end` offsets,
	// respectfully, in the input document.
	Location interface{} `json:"location,omitempty"`

	// The textual contents of this cell from the input document without associated markup content.
	Text *string `json:"text,omitempty"`

	// If you provide customization input, the normalized version of the cell text according to the customization;
	// otherwise, the same value as `text`.
	TextNormalized *string `json:"text_normalized,omitempty"`

	// The `begin` index of this cell's `row` location in the current table.
	RowIndexBegin *int64 `json:"row_index_begin,omitempty"`

	// The `end` index of this cell's `row` location in the current table.
	RowIndexEnd *int64 `json:"row_index_end,omitempty"`

	// The `begin` index of this cell's `column` location in the current table.
	ColumnIndexBegin *int64 `json:"column_index_begin,omitempty"`

	// The `end` index of this cell's `column` location in the current table.
	ColumnIndexEnd *int64 `json:"column_index_end,omitempty"`
}

type TableElementLocation struct {

	// The element's `begin` index.
	Begin *int64 `json:"begin" validate:"required"`

	// The element's `end` index.
	End *int64 `json:"end" validate:"required"`
}

type TableHeaders struct {

	// The unique ID of the cell in the current table.
	CellID *string `json:"cell_id,omitempty"`

	// The location of the table header cell in the current table as defined by its `begin` and `end` offsets,
	// respectfully, in the input document.
	Location interface{} `json:"location,omitempty"`

	// The textual contents of the cell from the input document without associated markup content.
	Text *string `json:"text,omitempty"`

	// The `begin` index of this cell's `row` location in the current table.
	RowIndexBegin *int64 `json:"row_index_begin,omitempty"`

	// The `end` index of this cell's `row` location in the current table.
	RowIndexEnd *int64 `json:"row_index_end,omitempty"`

	// The `begin` index of this cell's `column` location in the current table.
	ColumnIndexBegin *int64 `json:"column_index_begin,omitempty"`

	// The `end` index of this cell's `column` location in the current table.
	ColumnIndexEnd *int64 `json:"column_index_end,omitempty"`
}

type TableKeyValuePairs struct {

	// A key in a key-value pair.
	Key *TableCellKey `json:"key,omitempty"`

	// A list of values in a key-value pair.
	Value []TableCellValues `json:"value,omitempty"`
}

type TableResultTable struct {

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *TableElementLocation `json:"location,omitempty"`

	// The textual contents of the current table from the input document without associated markup content.
	Text *string `json:"text,omitempty"`

	// Text and associated location within a table.
	SectionTitle *TableTextLocation `json:"section_title,omitempty"`

	// Text and associated location within a table.
	Title *TableTextLocation `json:"title,omitempty"`

	// An array of table-level cells that apply as headers to all the other cells in the current table.
	TableHeaders []TableHeaders `json:"table_headers,omitempty"`

	// An array of row-level cells, each applicable as a header to other cells in the same row as itself, of the current
	// table.
	RowHeaders []TableRowHeaders `json:"row_headers,omitempty"`

	// An array of column-level cells, each applicable as a header to other cells in the same column as itself, of the
	// current table.
	ColumnHeaders []TableColumnHeaders `json:"column_headers,omitempty"`

	// An array of key-value pairs identified in the current table.
	KeyValuePairs []TableKeyValuePairs `json:"key_value_pairs,omitempty"`

	// An array of cells that are neither table header nor column header nor row header cells, of the current table with
	// corresponding row and column header associations.
	BodyCells []TableBodyCells `json:"body_cells,omitempty"`

	// An array of lists of textual entries across the document related to the current table being parsed.
	Contexts []TableTextLocation `json:"contexts,omitempty"`
}

type TableRowHeaderIds struct {

	// The `id` values of a row header.
	ID *string `json:"id,omitempty"`
}

type TableRowHeaderTexts struct {

	// The `text` value of a row header.
	Text *string `json:"text,omitempty"`
}

type TableRowHeaderTextsNormalized struct {

	// The normalized version of a row header text.
	TextNormalized *string `json:"text_normalized,omitempty"`
}

type TableRowHeaders struct {

	// The unique ID of the cell in the current table.
	CellID *string `json:"cell_id,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *TableElementLocation `json:"location,omitempty"`

	// The textual contents of this cell from the input document without associated markup content.
	Text *string `json:"text,omitempty"`

	// If you provide customization input, the normalized version of the cell text according to the customization;
	// otherwise, the same value as `text`.
	TextNormalized *string `json:"text_normalized,omitempty"`

	// The `begin` index of this cell's `row` location in the current table.
	RowIndexBegin *int64 `json:"row_index_begin,omitempty"`

	// The `end` index of this cell's `row` location in the current table.
	RowIndexEnd *int64 `json:"row_index_end,omitempty"`

	// The `begin` index of this cell's `column` location in the current table.
	ColumnIndexBegin *int64 `json:"column_index_begin,omitempty"`

	// The `end` index of this cell's `column` location in the current table.
	ColumnIndexEnd *int64 `json:"column_index_end,omitempty"`
}

type TableTextLocation struct {

	// The text retrieved.
	Text *string `json:"text,omitempty"`

	// The numeric location of the identified element in the document, represented with two integers labeled `begin` and
	// `end`.
	Location *TableElementLocation `json:"location,omitempty"`
}

type TrainingExample struct {

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

	// The collection ID associated with this training example.
	CollectionID *string `json:"collection_id" validate:"required"`

	// The relevance of the training example.
	Relevance *int64 `json:"relevance" validate:"required"`

	// The date and time the example was created.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The date and time the example was updated.
	Updated *strfmt.DateTime `json:"updated,omitempty"`
}

type TrainingQuery struct {

	// The query ID associated with the training query.
	QueryID *string `json:"query_id,omitempty"`

	// The natural text query for the training query.
	NaturalLanguageQuery *string `json:"natural_language_query" validate:"required"`

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

	// The date and time the query was created.
	Created *strfmt.DateTime `json:"created,omitempty"`

	// The date and time the query was updated.
	Updated *strfmt.DateTime `json:"updated,omitempty"`

	// Array of training examples.
	Examples []TrainingExample `json:"examples" validate:"required"`
}

type TrainingQuerySet struct {

	// Array of training queries.
	Queries []TrainingQuery `json:"queries,omitempty"`
}

type UpdateCollectionOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_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"`

	// An array of enrichments that are applied to this collection.
	Enrichments []CollectionEnrichment `json:"enrichments,omitempty"`

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

type UpdateDocumentOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_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 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"`

	// When `true`, the uploaded document is added to the collection even if the data for that collection is shared with
	// other collections.
	XWatsonDiscoveryForce *bool `json:"X-Watson-Discovery-Force,omitempty"`

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

type UpdateEnrichmentOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

	// The ID of the enrichment.
	EnrichmentID *string `json:"enrichment_id" validate:"required"`

	// A new name for the enrichment.
	Name *string `json:"name" validate:"required"`

	// A new description for the enrichment.
	Description *string `json:"description,omitempty"`

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

type UpdateProjectOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

	// The new name to give this project.
	Name *string `json:"name,omitempty"`

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

type UpdateTrainingQueryOptions struct {

	// The ID of the project. This information can be found from the deploy page of the Discovery administrative tooling.
	ProjectID *string `json:"project_id" validate:"required"`

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

	// The natural text query for the training query.
	NaturalLanguageQuery *string `json:"natural_language_query" validate:"required"`

	// Array of training examples.
	Examples []TrainingExample `json:"examples" validate:"required"`

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

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