ConceptInsights (Watson Developer Cloud Java Wrapper 1.1.0 API)

java.lang.Object
- com.ibm.watson.developer_cloud.service.WatsonService
- - com.ibm.watson.developer_cloud.concept_insights.v2.ConceptInsights

```
public class ConceptInsights
extends WatsonService
```
The IBM Watson™ Concept Insights service provides APIs that enable you to work with concepts and identify conceptual associations in the content that you provide as input to the service. Input content is auto-tagged against a concept graph, which is a formal representation of the relationship(s) between concepts. The concept graph used by the Concept Insights service is based on content that has been ingested from the English language Wikipedia.

Version:

v2

Author:

Nizar Alseddeg (nmalsedd@us.ibm.com)

See Also:

Concept Insights

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCOUNT_ID` The Constant ACCOUNT_ID.
`static String`	`CONCEPT` The Constant CONCEPT.
`static String`	`CONCEPT_FIELDS` The Constant CONCEPT_FIELDS.
`static String`	`CONCEPT_ID` The Constant CONCEPT_ID.
`static String`	`CONCEPTS` The Constant CONCEPTS.
`static String`	`CORPUS` The Constant CORPUS.
`static String`	`CURSOR` The Constant CURSOR.
`static String`	`DOCUMENT` The Constant DOCUMENT.
`static String`	`DOCUMENT_FIELDS` The Constant DOCUMENT_FIELDS.
`static String`	`DOCUMENTS` The Constant DOCUMENTS.
`static String`	`GRAPH` The Constant GRAPH NAME.
`static String`	`IDS` The Constant IDS.
`static String`	`LEVEL` The Constant LEVEL.
`static String`	`LIMIT` The Constant LIMIT.
`static String`	`PREFIX` The Constant PREFIX.
`static String`	`QUERY` The Constant query.
`static String`	`TEXT` The Constant TEXT.

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService
FORWARD_SLASH

Constructor Summary

Constructors
Constructor and Description

ConceptInsights()
Instantiates a new Concept Insights service.

Constructors
Constructor and Description
`ConceptInsights()` Instantiates a new Concept Insights service.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Annotations`	`annotateText(Map<String,Object> parameters)` Identifies concepts in a piece of text.
`QueryConcepts`	`conceptualSearch(Map<String,Object> parameters)` Performs a conceptual search within a corpus.
`void`	`createCorpus(String accountId, Corpus corpus)` Creates an empty corpus.
`void`	`createDocument(String accountId, String corpusName, Document document)` Creates a document in a given corpus.
`void`	`deleteCorpus(String accountId, String corpusName)` Deletes a corpus by ID.
`void`	`deleteDocument(String accountId, String corpusName, String documentName)` Deletes a document in a given corpus.
`Accounts`	`getAccountsInfo()` Retrieves the account identifiers.
`ConceptMetadata`	`getConcept(Map<String,Object> parameters)` Returns information for a specific concept node in a graph.
`Corpus`	`getCorpus(String accountId, String corpusName)` Retrieves corpus object to a list of individual concepts.
`CorpusProcessingState`	`getCorpusProcessingState(String accountId, String corpusName)` Gets processing state of a Corpus.
`Concepts`	`getCorpusRelatedConcepts(Map<String,Object> parameters)` Retrieves concepts that are related to an entire corpus.
`Scores`	`getCorpusRelationScores(Map<String,Object> parameters)` Returns a list of scores that denotes how related an entire corpus is to a list of individual concepts.
`CorpusStats`	`getCorpusStats(String accountId, String corpusName)` Gets processing state of a Corpus.
`Document`	`getDocument(String accountId, String corpusName, String documentName)` Retrieves a document from a corpus.
`DocumentAnnotations`	`getDocumentAnnotations(String accountId, String corpusName, String documentName)` Retrieves conceptual view of document (including annotations).
`DocumentProcessingStatus`	`getDocumentProcessingState(String accountId, String corpusName, String documentName)` Retrieves processing state of document.
`Concepts`	`getDocumentRelatedConcepts(Map<String,Object> parameters)` Retrieves concepts that are related (in conceptual sense) to a given document.
`Scores`	`getDocumentRelationScores(Map<String,Object> parameters)` Retrieves concepts that are related (in conceptual sense) to a given document.
`Concepts`	`getGraphsRelatedConcepts(Map<String,Object> parameters)` Searches for graph concepts by using partial matches.
`Scores`	`getGraphsRelationScores(Map<String,Object> parameters)` Returns a list of scores that denotes how related a source concept is to a list of individual concepts.
`Corpora`	`listCorpora()` Retrieves the available corpus objects.
`Corpora`	`listCorpora(String accountId)` Retrieves the available corpus objects associated with an account identifier.
`Documents`	`listDocuments(Map<String,Object> parameters)` Retrieves the document ids of a corpus.
`Graphs`	`listGraphs()` Retrieves the available `Graphs`.
`Matches`	`searchCorpusByLabel(Map<String,Object> parameters)` Searches for documents and concepts by using partial matches on the label(s) fields.
`Matches`	`searchGraphsConceptByLabel(Map<String,Object> parameters)` Searches for graph concepts by using partial matches.
`void`	`updateCorpus(String accountId, Corpus corpus)` Updates existing corpus meta-data (access and permissions).
`void`	`updateDocument(String accountId, String corpusName, Document document)` Updates a document in a given corpus.

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService
execute, executeRequest, executeWithoutResponse, getApiKey, getDefaultContentType, getDefaultRequestParams, getEndPoint, getHttpClient, getThreadSafeClient, setApiKey, setAuthentication, setEndPoint, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ACCOUNT_ID
```
public static final String ACCOUNT_ID
```
    The Constant ACCOUNT_ID. (value is "account_id")
    
    See Also:
    
    Constant Field Values
  - CONCEPT_ID
```
public static final String CONCEPT_ID
```
    The Constant CONCEPT_ID. (value is "concept_id")
    
    See Also:
    
    Constant Field Values
  - CONCEPT
```
public static final String CONCEPT
```
    The Constant CONCEPT. (value is "concept")
    
    See Also:
    
    Constant Field Values
  - CONCEPT_FIELDS
```
public static final String CONCEPT_FIELDS
```
    The Constant CONCEPT_FIELDS. (value is "concept_fields")
    
    See Also:
    
    Constant Field Values
  - CONCEPTS
```
public static final String CONCEPTS
```
    The Constant CONCEPTS. (value is "concepts")
    
    See Also:
    
    Constant Field Values
  - CORPUS
```
public static final String CORPUS
```
    The Constant CORPUS. (value is "graph")
    
    See Also:
    
    Constant Field Values
  - CURSOR
```
public static final String CURSOR
```
    The Constant CURSOR. (value is "graph")
    
    See Also:
    
    Constant Field Values
  - DOCUMENT
```
public static final String DOCUMENT
```
    The Constant DOCUMENT. (value is "graph")
    
    See Also:
    
    Constant Field Values
  - DOCUMENT_FIELDS
```
public static final String DOCUMENT_FIELDS
```
    The Constant DOCUMENT_FIELDS. (value is "document_fields")
    
    See Also:
    
    Constant Field Values
  - DOCUMENTS
```
public static final String DOCUMENTS
```
    The Constant DOCUMENTS. (value is "graph")
    
    See Also:
    
    Constant Field Values
  - GRAPH
```
public static final String GRAPH
```
    The Constant GRAPH NAME. (value is "graph")
    
    See Also:
    
    Constant Field Values
  - IDS
```
public static final String IDS
```
    The Constant IDS. (value is "ids")
    
    See Also:
    
    Constant Field Values
  - LEVEL
```
public static final String LEVEL
```
    The Constant LEVEL. (value is "level")
    
    See Also:
    
    Constant Field Values
  - LIMIT
```
public static final String LIMIT
```
    The Constant LIMIT. (value is "limit")
    
    See Also:
    
    Constant Field Values
  - PREFIX
```
public static final String PREFIX
```
    The Constant PREFIX. (value is "prefix")
    
    See Also:
    
    Constant Field Values
  - QUERY
```
public static final String QUERY
```
    The Constant query. (value is "query")
    
    See Also:
    
    Constant Field Values
  - TEXT
```
public static final String TEXT
```
    The Constant TEXT. (value is "text")
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ConceptInsights
```
public ConceptInsights()
```
    Instantiates a new Concept Insights service.
- Method Detail
  - annotateText
```
public Annotations annotateText(Map<String,Object> parameters)
```
    Identifies concepts in a piece of text.
    Parameters:
    parameters - The parameters to be used in the service call, account_id, graph and text are required.
    
    String account_id - The account identifier.
    
    String graph - The graph name.
    
    String text - The text to annotate.
    Returns:
    
    Annotations
  - conceptualSearch
```
public QueryConcepts conceptualSearch(Map<String,Object> parameters)
```
    Performs a conceptual search within a corpus.
    Parameters:
    parameters - The parameters to be used in the service call, account_id, corpus and ids are required.
    
    String account_id - The account identifier.
    
    String corpus - The corpus name.
    
    RequestedFields concept_fields - Additional fields to be included in the concept objects.
    
    RequestedFields document_fields - Additional fields to be included in the document objects.
    
    String ids - JSON array of concept and/or document ids.
    
    Integer cursor - A number of items to skip.
    
    Integer limit - The maximum number of concepts to be returned.
    Returns:
    
    QueryConcepts
  - createCorpus
```
public void createCorpus(String accountId,
                         Corpus corpus)
```
    Creates an empty corpus.
    
    Parameters:
    
    accountId - String the Account identifier,
    
    corpus - String the corpus name.
  - createDocument
```
public void createDocument(String accountId,
                           String corpusName,
                           Document document)
```
    Creates a document in a given corpus.
    
    Parameters:
    
    accountId - String the account identifier,
    
    corpusName - String the corpus name.
    
    document - Document The document to create.
  - deleteCorpus
```
public void deleteCorpus(String accountId,
                         String corpusName)
```
    Deletes a corpus by ID.
    
    Parameters:
    
    accountId - String the Account identifier.
    
    corpusName - String the corpus name.
  - deleteDocument
```
public void deleteDocument(String accountId,
                           String corpusName,
                           String documentName)
```
    Deletes a document in a given corpus.
    
    Parameters:
    
    accountId - String the account identifier,
    
    corpusName - String the corpus name.
    
    documentName - String the document name.
  - getAccountsInfo
```
public Accounts getAccountsInfo()
```
    Retrieves the account identifiers.
    
    Returns:
    
    the Accounts
  - getConcept
```
public ConceptMetadata getConcept(Map<String,Object> parameters)
```
    Returns information for a specific concept node in a graph.
    Parameters:
    parameters - The parameters to be used in the service call, account_id, graph and concept are required.
    
    String account_id - The account identifier.
    
    String graph - The graph name.
    
    String concept - The concept name.
    Returns:
    
    ConceptMetadata
  - getCorpus
```
public Corpus getCorpus(String accountId,
                        String corpusName)
```
    Retrieves corpus object to a list of individual concepts.
    
    Parameters:
    
    accountId - String the Account identifier.
    
    corpusName - String the corpus name.
    
    Returns:
    
    the Corpus
  - getCorpusProcessingState
```
public CorpusProcessingState getCorpusProcessingState(String accountId,
                                                      String corpusName)
```
    Gets processing state of a Corpus.
    
    Parameters:
    
    accountId - String the account identifier,
    
    corpusName - String the corpus name.
    
    Returns:
    
    CorpusProcessingState The processing state of a given corpus.
  - getCorpusRelatedConcepts
```
public Concepts getCorpusRelatedConcepts(Map<String,Object> parameters)
```
    Retrieves concepts that are related to an entire corpus.
    Parameters:
    parameters - The parameters to be used in the service call, account_id, corpus and concepts are required.
    
    String account_id - The account identifier.
    
    String corpus - The corpus name.
    
    RequestedFields concept_fields - Additional fields to be included in the concept objects.
    
    Integer level - A number in the range 0 - 3 that represents the level of popularity of related concepts.
    
    Integer limit - The maximum number of concepts to be returned.
    Returns:
    
    Concepts
  - getCorpusRelationScores
```
public Scores getCorpusRelationScores(Map<String,Object> parameters)
```
    Returns a list of scores that denotes how related an entire corpus is to a list of individual concepts.
    Parameters:
    parameters - The parameters to be used in the service call, account_id, corpus and concepts are required.
    
    String account_id - The account identifier.
    
    String corpus - The corpus name.
    
    List<String> concepts - Array of concept IDs, each identifying a concept.
    Returns:
    
    Scores
  - getCorpusStats
```
public CorpusStats getCorpusStats(String accountId,
                                  String corpusName)
```
    Gets processing state of a Corpus.
    
    Parameters:
    
    accountId - String the account identifier,
    
    corpusName - String the corpus name.
    
    Returns:
    
    the CorpusStats
  - getDocument
```
public Document getDocument(String accountId,
                            String corpusName,
                            String documentName)
```
    Retrieves a document from a corpus.
    
    Parameters:
    
    accountId - String the account identifier,
    
    corpusName - String the corpus name.
    
    documentName - String the document name.
    
    Returns:
    
    Document
  - getDocumentAnnotations
```
public DocumentAnnotations getDocumentAnnotations(String accountId,
                                                  String corpusName,
                                                  String documentName)
```
    Retrieves conceptual view of document (including annotations).
    
    Parameters:
    
    accountId - String the account identifier,
    
    corpusName - String the corpus name,
    
    documentName - String the document name.
    
    Returns:
    
    DocumentAnnotations
  - getDocumentProcessingState
```
public DocumentProcessingStatus getDocumentProcessingState(String accountId,
                                                           String corpusName,
                                                           String documentName)
```
    Retrieves processing state of document.
    
    Parameters:
    
    accountId - String the account identifier,
    
    corpusName - String the corpus name,
    
    documentName - String the document name.
    
    Returns:
    
    DocumentProcessingStatus
  - getDocumentRelatedConcepts
```
public Concepts getDocumentRelatedConcepts(Map<String,Object> parameters)
```
    Retrieves concepts that are related (in conceptual sense) to a given document.
    Parameters:
    parameters - The parameters to be used in the service call, account_id, corpus, document are required.
    
    String account_id - The account identifier.
    
    String corpus - The corpus name.
    
    String document - The document name.
    
    Integer level - A number in the range 0 - 3 that represents the level of popularity of related concepts.
    
    Integer limit - The maximum number of concepts to be returned.
    
    RequestedFields concept_fields - Additional fields to be included in the concept objects.
    Returns:
    
    Concepts
  - getDocumentRelationScores
```
public Scores getDocumentRelationScores(Map<String,Object> parameters)
```
    Retrieves concepts that are related (in conceptual sense) to a given document.
    Parameters:
    parameters - The parameters to be used in the service call, account_id, corpus, document and concepts are required.
    
    String account_id - The account identifier.
    
    String corpus - The corpus name.
    
    String document - The document name.
    
    List<String> concepts - Array of concept IDs, each identifying a concept.
    Returns:
    
    Scores
  - getGraphsRelatedConcepts
```
public Concepts getGraphsRelatedConcepts(Map<String,Object> parameters)
```
    Searches for graph concepts by using partial matches.
    Parameters:
    parameters - The parameters to be used in the service call, account_id, graph are required.
    
    String account_id - The account identifier.
    
    String graph - The graph name.
    
    List<String> concepts - Array of concept IDs, each identifying a concept.
    
    String concept - the concept name.
    
    Integer level - A number in the range 0 - 3 that represents the level of popularity of related concepts.
    
    Integer limit - The maximum number of concepts to be returned.
    Returns:
    
    Concepts
  - getGraphsRelationScores
```
public Scores getGraphsRelationScores(Map<String,Object> parameters)
```
    Returns a list of scores that denotes how related a source concept is to a list of individual concepts.
    Parameters:
    parameters - The parameters to be used in the service call, account_id, graph and concept or concepts are required.
    
    String account_id - The account identifier.
    
    String graph - The graph name.
    
    String concept - The concept name.
    
    List<String> concepts - Array of concept IDs, each identifying a concept.
    Returns:
    
    Scores
  - listCorpora
```
public Corpora listCorpora()
```
    Retrieves the available corpus objects.
    
    Returns:
    
    Corpora
  - listCorpora
```
public Corpora listCorpora(String accountId)
```
    Retrieves the available corpus objects associated with an account identifier.
    
    Parameters:
    
    accountId - The account identifier.
    
    Returns:
    
    Corpora
  - listDocuments
```
public Documents listDocuments(Map<String,Object> parameters)
```
    Retrieves the document ids of a corpus.
    Parameters:
    parameters - The parameters to be used in the service call, account_id, and corpus are required.
    
    String account_id - The account identifier.
    
    String corpus - The corpus name.
    
    String concept - The concept name.
    
    String query - For query syntax see API Explorer.
    JSON object that allows to filter the list of documents. Valid values are {"status":"error"}, {"status":"processing"}, and {"status":"ready"} which allow to filter documents by status.
    
    Integer cursor - The number of possible items to return. Specify '0' to return the maximum value of 100,000...
    
    Integer limit - The number of possible concepts to return..
    Returns:
    
    Documents
  - listGraphs
```
public Graphs listGraphs()
```
    Retrieves the available Graphs.
    
    Returns:
    
    the Graphs
  - searchCorpusByLabel
```
public Matches searchCorpusByLabel(Map<String,Object> parameters)
```
    Searches for documents and concepts by using partial matches on the label(s) fields.
    Parameters:
    parameters - The parameters to be used in the service call, account_id, corpus and query are required.
    
    String account_id - The account identifier.
    
    String corpus - The corpus name.
    
    RequestedFields concept_fields - Additional fields to be included in the concept objects.
    
    RequestedFields document_fields - Additional fields to be included in the document objects.
    
    Boolean concepts - Whether to return concepts that have a label match.
    
    String query - The query string.
    
    Boolean prefix - Whether the query string should be treated as a prefix.
    
    Integer limit - The maximum number of concepts to be returned.
    Returns:
    
    Matches
  - searchGraphsConceptByLabel
```
public Matches searchGraphsConceptByLabel(Map<String,Object> parameters)
```
    Searches for graph concepts by using partial matches.
    Parameters:
    parameters - The parameters to be used in the service call, account_id, graph and query are required.
    
    String account_id - The account identifier.
    
    String graph - The graph name.
    
    String query - The query string.
    
    Boolean prefix - Whether the query string should be treated as a prefix.
    
    Integer limit - The maximum number of items to be returned.
    
    RequestedFields concept_fields - An additional fields to include in the concept objects.
    Returns:
    
    Matches
  - updateCorpus
```
public void updateCorpus(String accountId,
                         Corpus corpus)
```
    Updates existing corpus meta-data (access and permissions).
    
    Parameters:
    
    accountId - String the Account identifier.
    
    corpus - Corpus the corpus to update.
  - updateDocument
```
public void updateDocument(String accountId,
                           String corpusName,
                           Document document)
```
    Updates a document in a given corpus.
    
    Parameters:
    
    accountId - String the account identifier,
    
    corpusName - String the corpus name.
    
    document - Document The document to update.

Class ConceptInsights

Field Summary

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

Constructor Summary

Method Summary

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

Methods inherited from class java.lang.Object

Field Detail

ACCOUNT_ID

CONCEPT_ID

CONCEPT

CONCEPT_FIELDS

CONCEPTS

CORPUS

CURSOR

DOCUMENT

DOCUMENT_FIELDS

DOCUMENTS

GRAPH

IDS

LEVEL

LIMIT

PREFIX

QUERY

TEXT

Constructor Detail

ConceptInsights

Method Detail

annotateText

conceptualSearch

createCorpus

createDocument

deleteCorpus

deleteDocument

getAccountsInfo

getConcept

getCorpus

getCorpusProcessingState

getCorpusRelatedConcepts

getCorpusRelationScores

getCorpusStats

getDocument

getDocumentAnnotations

getDocumentProcessingState

getDocumentRelatedConcepts

getDocumentRelationScores

getGraphsRelatedConcepts

getGraphsRelationScores

listCorpora

listCorpora

listDocuments

listGraphs

searchCorpusByLabel

searchGraphsConceptByLabel

updateCorpus

updateDocument