Interface | Description |
---|---|
ComponentSettingsAggregation.VisualizationType |
Type of visualization to use when rendering the aggregation.
|
CreateEnrichment.Type |
The type of this enrichment.
|
CreateProjectOptions.Type |
The project type of this project.
|
DeleteDocumentResponse.Status |
Status of the document.
|
DocumentAccepted.Status |
Status of the document in the ingestion process.
|
Enrichment.Type |
The type of this enrichment.
|
Field.Type |
The type of the field.
|
Notice.Severity |
Severity level of the notice.
|
ProjectDetails.Type |
The project type of this project.
|
ProjectListDetails.Type |
The project type of this project.
|
QueryResultMetadata.DocumentRetrievalSource |
The document retrieval source that produced this search result.
|
RetrievalDetails.DocumentRetrievalStrategy |
Identifies the document retrieval strategy used for this query.
|
Class | Description |
---|---|
AddDocumentOptions |
The addDocument options.
|
AddDocumentOptions.Builder |
Builder.
|
AnalyzedDocument |
An object containing the converted document and any identified enrichments.
|
AnalyzeDocumentOptions |
The analyzeDocument options.
|
AnalyzeDocumentOptions.Builder |
Builder.
|
AnalyzedResult |
Result of the document analysis.
|
Collection |
A collection for storing documents.
|
CollectionDetails |
A collection for storing documents.
|
CollectionDetails.Builder |
Builder.
|
CollectionEnrichment |
An object describing an Enrichment for a collection.
|
CollectionEnrichment.Builder |
Builder.
|
Completions |
An object containing an array of autocompletion suggestions.
|
ComponentSettingsAggregation |
Display settings for aggregations.
|
ComponentSettingsFieldsShown |
Fields shown in the results section of the UI.
|
ComponentSettingsFieldsShownBody |
Body label.
|
ComponentSettingsFieldsShownTitle |
Title label.
|
ComponentSettingsResponse |
The default component settings for this project.
|
CreateCollectionOptions |
The createCollection options.
|
CreateCollectionOptions.Builder |
Builder.
|
CreateEnrichment |
Information about a specific enrichment.
|
CreateEnrichment.Builder |
Builder.
|
CreateEnrichmentOptions |
The createEnrichment options.
|
CreateEnrichmentOptions.Builder |
Builder.
|
CreateProjectOptions |
The createProject options.
|
CreateProjectOptions.Builder |
Builder.
|
CreateTrainingQueryOptions |
The createTrainingQuery options.
|
CreateTrainingQueryOptions.Builder |
Builder.
|
DefaultQueryParams |
Default query parameters for this project.
|
DefaultQueryParams.Builder |
Builder.
|
DefaultQueryParamsPassages |
Default settings configuration for passage search options.
|
DefaultQueryParamsPassages.Builder |
Builder.
|
DefaultQueryParamsSuggestedRefinements |
Object containing suggested refinement settings.
|
DefaultQueryParamsSuggestedRefinements.Builder |
Builder.
|
DefaultQueryParamsTableResults |
Default project query settings for table results.
|
DefaultQueryParamsTableResults.Builder |
Builder.
|
DeleteCollectionOptions |
The deleteCollection options.
|
DeleteCollectionOptions.Builder |
Builder.
|
DeleteDocumentOptions |
The deleteDocument options.
|
DeleteDocumentOptions.Builder |
Builder.
|
DeleteDocumentResponse |
Information returned when a document is deleted.
|
DeleteEnrichmentOptions |
The deleteEnrichment options.
|
DeleteEnrichmentOptions.Builder |
Builder.
|
DeleteProjectOptions |
The deleteProject options.
|
DeleteProjectOptions.Builder |
Builder.
|
DeleteTrainingQueriesOptions |
The deleteTrainingQueries options.
|
DeleteTrainingQueriesOptions.Builder |
Builder.
|
DeleteTrainingQueryOptions |
The deleteTrainingQuery options.
|
DeleteTrainingQueryOptions.Builder |
Builder.
|
DeleteUserDataOptions |
The deleteUserData options.
|
DeleteUserDataOptions.Builder |
Builder.
|
DocumentAccepted |
Information returned after an uploaded document is accepted.
|
DocumentAttribute |
List of document attributes.
|
Enrichment |
Information about a specific enrichment.
|
EnrichmentOptions |
A object containing options for the current enrichment.
|
EnrichmentOptions.Builder |
Builder.
|
Enrichments |
An object containing an array of enrichment definitions.
|
Field |
Object containing field details.
|
GetAutocompletionOptions |
The getAutocompletion options.
|
GetAutocompletionOptions.Builder |
Builder.
|
GetCollectionOptions |
The getCollection options.
|
GetCollectionOptions.Builder |
Builder.
|
GetComponentSettingsOptions |
The getComponentSettings options.
|
GetComponentSettingsOptions.Builder |
Builder.
|
GetEnrichmentOptions |
The getEnrichment options.
|
GetEnrichmentOptions.Builder |
Builder.
|
GetProjectOptions |
The getProject options.
|
GetProjectOptions.Builder |
Builder.
|
GetTrainingQueryOptions |
The getTrainingQuery options.
|
GetTrainingQueryOptions.Builder |
Builder.
|
ListCollectionsOptions |
The listCollections options.
|
ListCollectionsOptions.Builder |
Builder.
|
ListCollectionsResponse |
Response object containing an array of collection details.
|
ListEnrichmentsOptions |
The listEnrichments options.
|
ListEnrichmentsOptions.Builder |
Builder.
|
ListFieldsOptions |
The listFields options.
|
ListFieldsOptions.Builder |
Builder.
|
ListFieldsResponse |
The list of fetched fields.
|
ListProjectsOptions |
The listProjects options.
|
ListProjectsResponse |
A list of projects in this instance.
|
ListTrainingQueriesOptions |
The listTrainingQueries options.
|
ListTrainingQueriesOptions.Builder |
Builder.
|
Notice |
A notice produced for the collection.
|
ProjectDetails |
Detailed information about the specified project.
|
ProjectListDetails |
Details about a specific project.
|
ProjectListDetailsRelevancyTrainingStatus |
Relevancy training status information for this project.
|
QueryAggregation |
An abstract aggregation type produced by Discovery to analyze the input provided.
|
QueryCalculationAggregation |
Returns a scalar calculation across all documents for the field specified.
|
QueryCollectionNoticesOptions |
The queryCollectionNotices options.
|
QueryCollectionNoticesOptions.Builder |
Builder.
|
QueryFilterAggregation |
A modifier that will narrow down the document set of the sub aggregations it precedes.
|
QueryGroupByAggregation |
Returns the top values for the field specified.
|
QueryGroupByAggregationResult |
Top value result for the term aggregation.
|
QueryHistogramAggregation |
Numeric interval segments to categorize documents by using field values from a single numeric
field to describe the category.
|
QueryHistogramAggregationResult |
Histogram numeric interval result.
|
QueryLargePassages |
Configuration for passage retrieval.
|
QueryLargePassages.Builder |
Builder.
|
QueryLargeSuggestedRefinements |
Configuration for suggested refinements.
|
QueryLargeSuggestedRefinements.Builder |
Builder.
|
QueryLargeTableResults |
Configuration for table retrieval.
|
QueryLargeTableResults.Builder |
Builder.
|
QueryNestedAggregation |
A restriction that alter the document set used for sub aggregations it precedes to nested
documents found in the field specified.
|
QueryNoticesOptions |
The queryNotices options.
|
QueryNoticesOptions.Builder |
Builder.
|
QueryNoticesResponse |
Object containing notice query results.
|
QueryOptions |
The query options.
|
QueryOptions.Builder |
Builder.
|
QueryResponse |
A response containing the documents and aggregations for the query.
|
QueryResponsePassage |
A passage query response.
|
QueryResult |
Result document for the specified query.
|
QueryResultMetadata |
Metadata of a query result.
|
QueryResultPassage |
A passage query result.
|
QuerySuggestedRefinement |
A suggested additional query term or terms user to filter results.
|
QueryTableResult |
A tables whose content or context match a search query.
|
QueryTermAggregation |
Returns the top values for the field specified.
|
QueryTermAggregationResult |
Top value result for the term aggregation.
|
QueryTimesliceAggregation |
A specialized histogram aggregation that uses dates to create interval segments.
|
QueryTimesliceAggregationResult |
A timeslice interval segment.
|
QueryTopHitsAggregation |
Returns the top documents ranked by the score of the query.
|
QueryTopHitsAggregationResult |
A query response containing the matching documents for the preceding aggregations.
|
ResultPassageAnswer |
Object containing a potential answer to the specified query.
|
RetrievalDetails |
An object contain retrieval type information.
|
TableBodyCells |
Cells that are not table header, column header, or row header cells.
|
TableCellKey |
A key in a key-value pair.
|
TableCellValues |
A value in a key-value pair.
|
TableColumnHeaderIds |
An array of values, each being the `id` value of a column header that is applicable to the
current cell.
|
TableColumnHeaders |
Column-level cells, each applicable as a header to other cells in the same column as itself, of
the current table.
|
TableColumnHeaderTexts |
An array of values, each being the `text` value of a column header that is applicable to the
current cell.
|
TableColumnHeaderTextsNormalized |
If you provide customization input, the normalized version of the column header texts according
to the customization; otherwise, the same value as `column_header_texts`.
|
TableElementLocation |
The numeric location of the identified element in the document, represented with two integers
labeled `begin` and `end`.
|
TableHeaders |
The contents of the current table's header.
|
TableKeyValuePairs |
Key-value pairs detected across cell boundaries.
|
TableResultTable |
Full table object retrieved from Table Understanding Enrichment.
|
TableRowHeaderIds |
An array of values, each being the `id` value of a row header that is applicable to this body
cell.
|
TableRowHeaders |
Row-level cells, each applicable as a header to other cells in the same row as itself, of the
current table.
|
TableRowHeaderTexts |
An array of values, each being the `text` value of a row header that is applicable to this body
cell.
|
TableRowHeaderTextsNormalized |
If you provide customization input, the normalized version of the row header texts according to
the customization; otherwise, the same value as `row_header_texts`.
|
TableTextLocation |
Text and associated location within a table.
|
TrainingExample |
Object containing example response details for a training query.
|
TrainingExample.Builder |
Builder.
|
TrainingQuery |
Object containing training query details.
|
TrainingQuery.Builder |
Builder.
|
TrainingQuerySet |
Object specifying the training queries contained in the identified training set.
|
UpdateCollectionOptions |
The updateCollection options.
|
UpdateCollectionOptions.Builder |
Builder.
|
UpdateDocumentOptions |
The updateDocument options.
|
UpdateDocumentOptions.Builder |
Builder.
|
UpdateEnrichmentOptions |
The updateEnrichment options.
|
UpdateEnrichmentOptions.Builder |
Builder.
|
UpdateProjectOptions |
The updateProject options.
|
UpdateProjectOptions.Builder |
Builder.
|
UpdateTrainingQueryOptions |
The updateTrainingQuery options.
|
UpdateTrainingQueryOptions.Builder |
Builder.
|
Copyright © 2021 IBM Cloud. All rights reserved.