com.ibm.watson.developer_cloud.concept_insights.v2

Class ConceptInsights

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

See Also:

Concept Insights

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONCEPT The Constant CONCEPT.
static String	CONCEPT_FIELDS The Constant CONCEPT_FIELDS.
static String	CONCEPTS The Constant CONCEPTS.
static String	CURSOR The Constant CURSOR.
static String	DOCUMENT_FIELDS The Constant DOCUMENT_FIELDS.
static String	DOCUMENTS_PATH The Constant DOCUMENTS.
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

VERSION

Constructor Summary

Constructors

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

Method Summary

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

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

configureHttpClient, execute, executeRequest, executeWithoutResponse, getApiKey, getEndPoint, getName, getToken, setApiKey, setAuthentication, setDefaultHeaders, setEndPoint, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

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

CURSOR

public static final String CURSOR

The Constant CURSOR. (value is "cursor")

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_PATH

public static final String DOCUMENTS_PATH

The Constant DOCUMENTS. (value is "documents")

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(Graph graph,
                                String text)

Identifies concepts in a piece of text.

Parameters:

graph - - The graph object.

text - - The text to annotate.

Returns:

Annotations

conceptualSearch

public QueryConcepts conceptualSearch(Corpus corpus,
                                      Map<String,Object> parameters)

Performs a conceptual search within a corpus.

Parameters:

corpus - the corpus

parameters - The parameters to be used in the service call ids is required.

• 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(Corpus corpus)

Creates an empty corpus.

Parameters:

corpus - Corpus the corpus object.

createDocument

public void createDocument(Document document)

Creates a document in a given corpus.

Parameters:

document - Document The document to create.

deleteCorpus

public void deleteCorpus(Corpus corpus)

Deletes a corpus by ID.

Parameters:

corpus - Corpus the corpus object.

deleteDocument

public void deleteDocument(Document document)

Deletes a document in a given corpus.

Parameters:

document - Document the document.

getAccountsInfo

public Accounts getAccountsInfo()

Retrieves the account identifiers.

Returns:

the Accounts

getConcept

public ConceptMetadata getConcept(Concept concept)

Returns information for a specific concept node in a graph.

Parameters:

concept - Concept the concept object.

Returns:

ConceptMetadata

getConceptRelatedConcepts

public Concepts getConceptRelatedConcepts(Concept concept,
                                          Map<String,Object> parameters)

Searches for graph concepts from a Concept by using partial matches.

Parameters:

concept - the concept

parameters - The parameters to be used in the service call.

• 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

getCorpus

public Corpus getCorpus(Corpus corpus)

Retrieves corpus object to a list of individual concepts.

Parameters:

corpus - Corpus the corpus object.

Returns:

the Corpus

getCorpusProcessingState

public CorpusProcessingState getCorpusProcessingState(Corpus corpus)

Gets processing state of a Corpus.

Parameters:

corpus - Corpus the corpus object.

Returns:

CorpusProcessingState The processing state of a given corpus.

getCorpusRelatedConcepts

public Concepts getCorpusRelatedConcepts(Corpus corpus,
                                         Map<String,Object> parameters)

Retrieves concepts that are related to an entire corpus.

Parameters:

corpus - the corpus

parameters - The parameters to be used in the service call.

• 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(Corpus corpus,
                                      List<Concept> concepts)

Returns a list of scores that denotes how related an entire corpus is to a list of individual concepts.

Parameters:

corpus - The corpus object

concepts - Array of concept IDs, each identifying a concept

Returns:

Scores

getCorpusStats

public CorpusStats getCorpusStats(Corpus corpus)

Gets processing state of a Corpus.

Parameters:

corpus - The corpus object

Returns:

the CorpusStats

getDocument

public Document getDocument(Document document)

Retrieves a document from a corpus.

Parameters:

document - Document the document object,

Returns:

Document

getDocumentAnnotations

public DocumentAnnotations getDocumentAnnotations(Document document)

Retrieves conceptual view of document (including annotations).

Parameters:

document - Document the document object,

Returns:

DocumentAnnotations

getDocumentProcessingState

public DocumentProcessingStatus getDocumentProcessingState(Document document)

Retrieves processing state of document.

Parameters:

document - Document the document object,

Returns:

DocumentProcessingStatus

getDocumentRelatedConcepts

public Concepts getDocumentRelatedConcepts(Document document,
                                           Map<String,Object> parameters)

Retrieves concepts that are related (in conceptual sense) to a given document.

Parameters:

document - the document

parameters - The parameters to be used in the service call.

• 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(Document document,
                                        List<Concept> concepts)

Returns a list of scores that denotes how related a document is to a list of concepts.

Parameters:

document - Document the document object,

concepts - the concepts

Returns:

Scores

getGraphRelatedConcepts

public Concepts getGraphRelatedConcepts(Graph graph,
                                        List<Concept> concepts,
                                        Map<String,Object> parameters)

Searches for graph concepts by using partial matches.

Parameters:

graph - the graph

concepts - the concepts

parameters - The parameters to be used in the service call, graph and concepts are required.

• 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

getGraphRelationScores

public Scores getGraphRelationScores(Concept concept,
                                     List<String> concepts)

Returns a list of scores that denotes how related a source concept is to a list of individual concepts.

Parameters:

concept - Concept the concept object,

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(Corpus corpus,
                               Map<String,Object> parameters)

Retrieves the document ids of a corpus.

Parameters:

corpus - the corpus

parameters - The parameters to be used in the service call.

• 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(Corpus corpus,
                                   Map<String,Object> parameters)

Searches for documents and concepts by using partial matches on the label(s) fields.

Parameters:

corpus - the corpus

parameters - The parameters to be used in the service call query is required.

• 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(Graph graph,
                                          Map<String,Object> parameters)

Searches for graph concepts by using partial matches.

Parameters:

graph - the graph

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(Corpus corpus)

Updates existing corpus meta-data (access and permissions).

Parameters:

corpus - Corpus the corpus to update.

updateDocument

public void updateDocument(Document document)

Updates a document in a given corpus.

Parameters:

document - Document The document to update.