ACE Director Alum Daniel Morgan, founder of Morgan's Library, is scheduling
complimentary technical Workshops on Database Security for the first 30
Oracle Database customers located anywhere in North America, EMEA, LATAM, or
APAC that send an email to
asra_us@oracle.com. Request a Workshop for
your organization today.
Purpose
PL/SQL package providing APIs for requesting document services, such as highlighting extracted text or generating a list of document themes.
Many of these procedures exist in two versions: those that make use of indexes, and those that don't. Those that don't are called "policy-based" procedures.
They are offered because there are times when you might like to use document services on a single document without creating a context index in advance.
The policy_* procedures mirror the conventional in-memory document services and are used with policy_name replacing index_ name, and document of type VARCHAR2, CLOB, BLOB or BFILE replacing textkey
eliminating the need to create an index to obtain document services output.
USC-2 codepoint semantics are followed for procedures that generate character offsets and lengths, such as HIGHLIGHT and TOKENS.
AUTHID
CURRENT_USER
Constants
Name
Data Type
Value
Save Copy
SAVE_COPY_FALLBACK
NUMBER
0
SAVE_COPY_ERROR
NUMBER
1
SAVE_COPY_IGNORE
NUMBER
2
Sentiment
SENT_DFLT_TYPE
VARCHAR2(10)
'EXACT'
SENT_DFLT_RADIUS
NUMBER
50
SENT_DFLT_MAXLEN
NUMBER
32767
SENT_DFLT_MAXINST
NUMBER
5
SENT_DFLT_STARTTAG
VARCHAR2(4)
'<b>'
SENT_DFLT_ENDTAG
VARCHAR2(4)
'</b>'
Thesaurus Default Token Types
THES_DFLT_TOK
VARCHAR2(10)
'SYN'
TYPE_ROWID
VARCHAR2(20)
'ROWID'
TYPE_PRIMARY_KEY
VARCHAR2(20)
'PRIMARY_KEY'
UNLIMITED_THEMES
NUMBER
NULL
STEM_DELIMITER
VARCHAR2(2)
'!?'
Data Types
TYPE theme_rec IS RECORD (
theme VARCHAR2(2000),
weight NUMBER);
TYPE theme_tab IS TABLE OF theme_rec
INDEX BY BINARY_INTEGER;
TYPE token_rec IS RECORD (
token VARCHAR2(255),
offset NUMBER,
length NUMBER,
thes_tokens VARCHAR2(4000));
TYPE token_tab IS TABLE OF token_rec
INDEX BY BINARY_INTEGER;
TYPE highlight_rec IS RECORD (
offset NUMBER,
length NUMBER);
TYPE highlight_tab IS TABLE OF highlight_rec
INDEX BY BINARY_INTEGER;
-- Beehive: Add record/table needed to return stems
TYPE stem_rec IS RECORD (
stem VARCHAR2(1000),
is_in_lexicon BOOLEAN);
TYPE stem_tab IS TABLE OF stem_rec
INDEX BY BINARY_INTEGER;
-- We made the size of word to be larger than the size used for tokens
-- as this might be a multi-word token
*/
TYPE stem_group_rec IS RECORD (
word VARCHAR2(1000),
stems stem_tab,
offset NUMBER,
length NUMBER);
TYPE stem_group_tab IS TABLE OF stem_group_rec
INDEX BY BINARY_INTEGER;
-- Beehive: Add record/table needed to return noun phrases
TYPE noun_phrase_rec IS RECORD (
term VARCHAR2(255),
pos_tag VARCHAR2(64),
offset NUMBER,
length NUMBER,
is_phrase_start BOOLEAN,
is_in_lexicon BOOLEAN);
TYPE noun_phrase_tab IS TABLE OF noun_phrase_rec
INDEX BY BINARY_INTEGER;
-- Beehive: Add record/table needed to return languages
TYPE language_rec IS RECORD (
language VARCHAR2(64),
score NUMBER);
TYPE language_tab IS TABLE OF language_rec
INDEX BY BINARY_INTEGER;
-- Beehive: Add record/table needed to return parts of speech
TYPE pos_tag_tab IS TABLE OF VARCHAR2(64)
INDEX BY BINARY_INTEGER;
TYPE part_of_speech_rec IS RECORD (
word VARCHAR2(255),
pos_tags pos_tag_tab,
offset NUMBER,
length NUMBER,
is_in_lexicon BOOLEAN);
TYPE part_of_speech_tab IS TABLE OF part_of_speech_rec
INDEX BY BINARY_INTEGER;
Takes a document reference and returns a plaintext version
Overload 1
ctx_doc.filter(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
restab IN VARCHAR2,
query_id IN NUMBER DEFAULT 0,
plaintext IN BOOLEAN DEFAULT FALSE,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback);
TBD
Returns the result into a CLOB locator instead of a result table
Overload 2
ctx_doc.filter(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback);
Generates gist(s) of a given document. The gist(s) will be written to the gist table specified
Overload 1
ctx_doc.gist(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
restab IN VARCHAR2,
query_id IN NUMBER DEFAULT 0,
glevel IN VARCHAR2 DEFAULT 'P',
pov IN VARCHAR2 DEFAULT NULL,
numParagraphs IN NUMBER DEFAULT NULL,
maxPercent IN NUMBER DEFAULT NULL,
num_themes IN NUMBER DEFAULT 50,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback);
TBD
Returns the result into a CLOB locator instead of a result table
Overload 2
ctx_doc.gist(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
restab IN OUT NOCOPY CLOB,
glevel IN VARCHAR2 DEFAULT 'P',
pov IN VARCHAR2 DEFAULT 'GENERIC',
numParagraphs IN NUMBER DEFAULT NULL,
maxPercent IN NUMBER DEFAULT NULL,
num_themes IN NUMBER DEFAULT 50,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback);
Takes a query and a VARCHAR2 document, and returns highlight information to a table
Overload 1
ctx_doc.highlight(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
text_query IN VARCHAR2,
restab IN VARCHAR2,
query_id IN NUMBER DEFAULT 0,
plaintext IN BOOLEAN DEFAULT FALSE,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback);
TBD
Takes a query and a VARCHAR2 document, and returns highlight information into a PL/SQL table
Overload 2
ctx_doc.highlight(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
text_query IN VARCHAR2,
restab IN OUT NOCOPY highlight_tab,
plaintext IN BOOLEAN DEFAULT FALSE,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback);
Takes a query and a CLOB document, and returns highlight information into a PL/SQL table
Overload 1
ctx_doc.highlight_clob_query(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
text_query IN CLOB,
restab IN VARCHAR2,
query_id IN NUMBER DEFAULT 0,
plaintext IN BOOLEAN DEFAULT FALSE,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback);
TBD
Takes a query and a CLOB document, and returns highlight information into a PL/SQL table
Overload 2
ctx_doc.highlight_clob_query(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
text_query IN CLOB,
restab IN OUT NOCOPY highlight_tab,
plaintext IN BOOLEAN DEFAULT FALSE,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback);
Takes a document reference and a query, and returns a marked-up plain text version of the document
Overload 1
ctx_doc.markup(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
text_query IN VARCHAR2,
restab IN VARCHAR2,
query_id IN NUMBER DEFAULT 0,
plaintext IN BOOLEAN DEFAULT FALSE,
tagset IN VARCHAR2 DEFAULT 'TEXT_DEFAULT',
starttag IN VARCHAR2 DEFAULT NULL,
endtag IN VARCHAR2 DEFAULT NULL,
prevtag IN VARCHAR2 DEFAULT NULL,
nexttag IN VARCHAR2 DEFAULT NULL,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback,
view_name IN VARCHAR2 DEFAULT NULL);
TBD
Returns the result into a CLOB locator instead of a result table
Overload 2
ctx_doc.markup(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
text_query IN VARCHAR2,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
tagset IN VARCHAR2 DEFAULT 'TEXT_DEFAULT',
starttag IN VARCHAR2 DEFAULT NULL,
endtag IN VARCHAR2 DEFAULT NULL,
prevtag IN VARCHAR2 DEFAULT NULL,
nexttag IN VARCHAR2 DEFAULT NULL,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback,
view_name IN VARCHAR2 DEFAULT NULL);
Takes a document reference and a query, and returns a marked-up plain text version of the document
Overload 1
ctx_doc.markup_clob_query(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
text_query IN CLOB,
restab IN VARCHAR2,
query_id IN NUMBER DEFAULT 0,
plaintext IN BOOLEAN DEFAULT FALSE,
tagset IN VARCHAR2 DEFAULT 'TEXT_DEFAULT',
starttag IN VARCHAR2 DEFAULT NULL,
endtag IN VARCHAR2 DEFAULT NULL,
prevtag IN VARCHAR2 DEFAULT NULL,
nexttag IN VARCHAR2 DEFAULT NULL,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback);
TBD
Returns the result into a CLOB locator instead of a result table
Overload 2
ctx_doc.markup_clob_query(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
text_query IN CLOB,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
tagset IN VARCHAR2 DEFAULT 'TEXT_DEFAULT',
starttag IN VARCHAR2 DEFAULT NULL,
endtag IN VARCHAR2 DEFAULT NULL,
prevtag IN VARCHAR2 DEFAULT NULL,
nexttag IN VARCHAR2 DEFAULT NULL,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback);
ctx_doc.policy_filter(
policy_name IN VARCHAR2,
document IN CLOB,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single BLOB document
Overload 2
ctx_doc.policy_filter(
policy_name IN VARCHAR2,
document IN BLOB,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
accepts a policy name and a single BFILE document. Returns the result into a CLOB locator
Overload 3
ctx_doc.policy_filter(
policy_name IN VARCHAR2,
document IN BFILE,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single VARCHAR2 document. Returns the result into a CLOB locator
Overload 4
ctx_doc.policy_filter(
policy_name IN VARCHAR2,
document IN VARCHAR2,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
Returns only one gist. If pov is not supplied, the GENERIC gist is returned.
Overload 1
ctx_doc.policy_gist(
policy_name IN VARCHAR2,
document IN VARCHAR2,
restab IN OUT NOCOPY CLOB,
glevel IN VARCHAR2 DEFAULT 'P',
pov IN VARCHAR2 DEFAULT 'GENERIC',
numParagraphs IN NUMBER DEFAULT NULL,
maxPercent IN NUMBER DEFAULT NULL,
num_themes IN NUMBER DEFAULT 50,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single CLOB document. Returns the result into a CLOB locator.
Overload 2
ctx_doc.policy_gist(
policy_name IN VARCHAR2,
document IN CLOB,
restab IN OUT NOCOPY CLOB,
glevel IN VARCHAR2 DEFAULT 'P',
pov IN VARCHAR2 DEFAULT 'GENERIC',
numParagraphs IN NUMBER DEFAULT NULL,
maxPercent IN NUMBER DEFAULT NULL,
num_themes IN NUMBER DEFAULT 50,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
accepts a policy name and a single BLOB document. Returns the result into a CLOB locator
Overload 3
ctx_doc.policy_gist(
policy_name IN VARCHAR2,
document IN BLOB,
restab IN OUT NOCOPY CLOB,
glevel IN VARCHAR2 DEFAULT 'P',
pov IN VARCHAR2 DEFAULT 'GENERIC',
numParagraphs IN NUMBER DEFAULT NULL,
maxPercent IN NUMBER DEFAULT NULL,
num_themes IN NUMBER DEFAULT 50,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
accepts a policy name and a single BFILE document. Returns the result into a CLOB locator.
Overload 4
ctx_doc.policy_gist(
policy_name IN VARCHAR2,
document IN BFILE,
restab IN OUT NOCOPY CLOB,
glevel IN VARCHAR2 DEFAULT 'P',
pov IN VARCHAR2 DEFAULT 'GENERIC',
numParagraphs IN NUMBER DEFAULT NULL,
maxPercent IN NUMBER DEFAULT NULL,
num_themes IN NUMBER DEFAULT 50,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
Accepts a policy name and a single VARCHAR2 document
Overload 1
ctx_doc.policy_highlight(
policy_name IN VARCHAR2,
document IN VARCHAR2,
text_query IN VARCHAR2,
restab IN OUT NOCOPY highlight_tab,
plaintext IN BOOLEAN DEFAULT FALSE,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single CLOB document
Overload 2
ctx_doc.policy_highlight(
policy_name IN VARCHAR2,
document IN CLOB,
text_query IN VARCHAR2,
restab IN OUT NOCOPY highlight_tab,
plaintext IN BOOLEAN DEFAULT FALSE,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
accepts a policy name and a single BLOB document
Overload 3
ctx_doc.policy_highlight(
policy_name IN VARCHAR2,
document IN BLOB,
text_query IN VARCHAR2,
restab IN OUT NOCOPY highlight_tab,
plaintext IN BOOLEAN DEFAULT FALSE,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single BFILE document
Overload 4
ctx_doc.policy_highlight(
policy_name IN VARCHAR2,
document IN BFILE,
text_query IN VARCHAR2,
restab IN OUT NOCOPY highlight_tab,
plaintext IN BOOLEAN DEFAULT FALSE,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
Accepts a policy name and a single VARCHAR2 document
Overload 1
ctx_doc.policy_highlight_clob_query(
policy_name IN VARCHAR2,
document IN VARCHAR2,
text_query IN CLOB,
restab IN OUT NOCOPY highlight_tab,
plaintext IN BOOLEAN DEFAULT FALSE,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single CLOB document
Overload 2
ctx_doc.policy_highlight_clob_query(
policy_name IN VARCHAR2,
document IN CLOB,
text_query IN CLOB,
restab IN OUT NOCOPY highlight_tab,
plaintext IN BOOLEAN DEFAULT FALSE,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
accepts a policy name and a single BLOB document
Overload 3
ctx_doc.policy_highlight_clob_query(
policy_name IN VARCHAR2,
document IN BLOB,
text_query IN CLOB,
restab IN OUT NOCOPY highlight_tab,
plaintext IN BOOLEAN DEFAULT FALSE,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single BFILE document
Overload 4
ctx_doc.policy_highlight_clob_query(
policy_name IN VARCHAR2,
document IN BFILE,
text_query IN CLOB,
restab IN OUT NOCOPY highlight_tab,
plaintext IN BOOLEAN DEFAULT FALSE,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
accepts a policy name and a single VARCHAR2 document
Overload 1
ctx_doc.policy_languages(
policy_languages (
policy_name IN VARCHAR2,
document IN VARCHAR2,
restab IN OUT NOCOPY language_tab,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
accepts a policy name and a single CLOB document
Overload 2
ctx_doc.policy_languages(
policy_name IN VARCHAR2,
document IN CLOB,
restab IN OUT NOCOPY language_tab,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
Accepts a policy name and a single VARCHAR2 document
Overload 1
ctx_doc.policy_markup(
policy_name IN VARCHAR2,
document IN VARCHAR2,
text_query IN VARCHAR2,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
tagset IN VARCHAR2 DEFAULT 'TEXT_DEFAULT',
starttag IN VARCHAR2 DEFAULT NULL,
endtag IN VARCHAR2 DEFAULT NULL,
prevtag IN VARCHAR2 DEFAULT NULL,
nexttag IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
view_name IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single CLOB document
Overload 2
ctx_doc.policy_markup(
policy_name IN VARCHAR2,
document IN CLOB,
text_query IN VARCHAR2,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
tagset IN VARCHAR2 DEFAULT 'TEXT_DEFAULT',
starttag IN VARCHAR2 DEFAULT NULL,
endtag IN VARCHAR2 DEFAULT NULL,
prevtag IN VARCHAR2 DEFAULT NULL,
nexttag IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
view_name IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single BLOB document
Overload 3
ctx_doc.policy_markup(
policy_name IN VARCHAR2,
document IN BLOB,
text_query IN VARCHAR2,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
tagset IN VARCHAR2 DEFAULT 'TEXT_DEFAULT',
starttag IN VARCHAR2 DEFAULT NULL,
endtag IN VARCHAR2 DEFAULT NULL,
prevtag IN VARCHAR2 DEFAULT NULL,
nexttag IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
view_name IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single BFILE document
Overload 4
ctx_doc.policy_markup(
policy_name IN VARCHAR2,
document IN BFILE,
text_query IN VARCHAR2,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
tagset IN VARCHAR2 DEFAULT 'TEXT_DEFAULT',
starttag IN VARCHAR2 DEFAULT NULL,
endtag IN VARCHAR2 DEFAULT NULL,
prevtag IN VARCHAR2 DEFAULT NULL,
nexttag IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
view_name IN VARCHAR2 DEFAULT NULL);
ctx_doc.policy_markup_clob_query(
policy_name IN VARCHAR2,
document IN VARCHAR2,
text_query IN CLOB,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
tagset IN VARCHAR2 DEFAULT 'TEXT_DEFAULT',
starttag IN VARCHAR2 DEFAULT NULL,
endtag IN VARCHAR2 DEFAULT NULL,
prevtag IN VARCHAR2 DEFAULT NULL,
nexttag IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single CLOB document
Overload 2
ctx_doc.policy_markup_clob_query(
policy_name IN VARCHAR2,
document IN CLOB,
text_query IN CLOB,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
tagset IN VARCHAR2 DEFAULT 'TEXT_DEFAULT',
starttag IN VARCHAR2 DEFAULT NULL,
endtag IN VARCHAR2 DEFAULT NULL,
prevtag IN VARCHAR2 DEFAULT NULL,
nexttag IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single BLOB document
Overload 3
ctx_doc.policy_markup_clob_query(
policy_name IN VARCHAR2,
document IN BLOB,
text_query IN CLOB,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
tagset IN VARCHAR2 DEFAULT 'TEXT_DEFAULT',
starttag IN VARCHAR2 DEFAULT NULL,
endtag IN VARCHAR2 DEFAULT NULL,
prevtag IN VARCHAR2 DEFAULT NULL,
nexttag IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single BFILE document
Overload 4
ctx_doc.policy_markup_clob_query(
policy_name IN VARCHAR2,
document IN BFILE,
text_query IN CLOB,
restab IN OUT NOCOPY CLOB,
plaintext IN BOOLEAN DEFAULT FALSE,
tagset IN VARCHAR2 DEFAULT 'TEXT_DEFAULT',
starttag IN VARCHAR2 DEFAULT NULL,
endtag IN VARCHAR2 DEFAULT NULL,
prevtag IN VARCHAR2 DEFAULT NULL,
nexttag IN VARCHAR2 DEFAULT NULL,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
accepts a policy name and a single VARCHAR2 document
Overload 1
ctx_doc.policy_noun_phrases(
policy_name IN VARCHAR2,
document IN VARCHAR2,
restab IN OUT NOCOPY noun_phrase_tab,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
accepts a policy name and a single CLOB document
Overload 2
ctx_doc.policy_noun_phrases(
policy_name IN VARCHAR2,
document IN CLOB,
restab IN OUT NOCOPY noun_phrase_tab,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
ctx_doc.policy_part_of_speech(
policy_name IN VARCHAR2,
document IN VARCHAR2,
restab IN OUT NOCOPY part_of_speech_tab,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
disambiguate_tags IN BOOLEAN DEFAULT TRUE);
TBD
Overload 2
ctx_doc.policy_part_of_speech(
policy_name IN VARCHAR2,
document IN CLOB,
restab IN OUT NOCOPY part_of_speech_tab,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
disambiguate_tags IN BOOLEAN DEFAULT TRUE);
Accepts a policy name and a single VARCHAR2 document and returns the snippet result
Overload 1
ctx_doc.policy_snippet(
policy_name IN VARCHAR2,
document IN VARCHAR2,
text_query IN VARCHAR2,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
starttag IN VARCHAR2 DEFAULT '<b>',
endtag IN VARCHAR2 DEFAULT '</b>',
entity_translation IN BOOLEAN DEFAULT TRUE,
separator IN VARCHAR2 DEFAULT '<b>...</b>',
radius IN NUMBER DEFAULT 25,
max_length IN NUMBER DEFAULT 250)
RETURN VARCHAR2;
TBD
Accepts a policy name and a single CLOB document and returns the snippet result
Overload 2
ctx_doc.policy_snippet(
policy_name IN VARCHAR2,
document IN CLOB,
text_query IN VARCHAR2,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
starttag IN VARCHAR2 DEFAULT '<b>',
endtag IN VARCHAR2 DEFAULT '</b>',
entity_translation IN BOOLEAN DEFAULT TRUE,
separator IN VARCHAR2 DEFAULT '<b>...</b>',
radius IN NUMBER DEFAULT 25,
max_length IN NUMBER DEFAULT 250)
RETURN VARCHAR2;
TBD
Accepts a policy name and a single BLOB document and returns the snippet result
Overload 3
ctx_doc.policy_snippet(
policy_name IN VARCHAR2,
document IN BLOB,
text_query IN VARCHAR2,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
starttag IN VARCHAR2 DEFAULT '<b>',
endtag IN VARCHAR2 DEFAULT '</b>',
entity_translation IN BOOLEAN DEFAULT TRUE,
separator IN VARCHAR2 DEFAULT '<b>...</b>',
radius IN NUMBER DEFAULT 25,
max_length IN NUMBER DEFAULT 250)
RETURN VARCHAR2;
TBD
Accepts a policy name and a single BFILE document and returns the snippet result
Overload 4
ctx_doc.policy_snippet(
policy_name IN VARCHAR2,
document IN BFILE,
text_query IN VARCHAR2,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
starttag IN VARCHAR2 DEFAULT '<b>',
endtag IN VARCHAR2 DEFAULT '</b>',
entity_translation IN BOOLEAN DEFAULT TRUE,
separator IN VARCHAR2 DEFAULT '<b>...</b>',
radius IN NUMBER DEFAULT 25,
max_length IN NUMBER DEFAULT 250)
RETURN VARCHAR2;
Accepts a policy name and a single VARCHAR2 document and returns the snippet result
Overload 1
ctx_doc.policy_snippet_clob_query(
policy_name IN VARCHAR2,
document IN VARCHAR2,
text_query IN CLOB,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
starttag IN VARCHAR2 DEFAULT '<b>',
endtag IN VARCHAR2 DEFAULT '</b>',
entity_translation IN BOOLEAN DEFAULT TRUE,
separator IN VARCHAR2 DEFAULT '<b>...</b>',
radius IN NUMBER DEFAULT 25,
max_length IN NUMBER DEFAULT 250)
RETURN VARCHAR2;
TBD
Accepts a policy name and a single CLOB document and returns the snippet result
Overload 2
ctx_doc.policy_snippet_clob_query(
policy_name IN VARCHAR2,
document IN CLOB,
text_query IN CLOB,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
starttag IN VARCHAR2 DEFAULT '<b>',
endtag IN VARCHAR2 DEFAULT '</b>',
entity_translation IN BOOLEAN DEFAULT TRUE,
separator IN VARCHAR2 DEFAULT '<b>...</b>',
radius IN NUMBER DEFAULT 25,
max_length IN NUMBER DEFAULT 250)
RETURN VARCHAR2;
TBD
Accepts a policy name and a single BLOB document and returns the snippet result
Overload 3
ctx_doc.policy_snippet_clob_query(
policy_name IN VARCHAR2,
document IN BLOB,
text_query IN CLOB,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
starttag IN VARCHAR2 DEFAULT '<b>',
endtag IN VARCHAR2 DEFAULT '</b>',
entity_translation IN BOOLEAN DEFAULT TRUE,
separator IN VARCHAR2 DEFAULT '<b>...</b>',
radius IN NUMBER DEFAULT 25,
max_length IN NUMBER DEFAULT 250)
RETURN VARCHAR2;
TBD
Accepts a policy name and a single BFILE document and returns the snippet result
Overload 4
ctx_doc.policy_snippet_clob_query(
policy_name IN VARCHAR2,
document IN BFILE,
text_query IN CLOB,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
starttag IN VARCHAR2 DEFAULT '<b>',
endtag IN VARCHAR2 DEFAULT '</b>',
entity_translation IN BOOLEAN DEFAULT TRUE,
separator IN VARCHAR2 DEFAULT '<b>...</b>',
radius IN NUMBER DEFAULT 25,
max_length IN NUMBER DEFAULT 250)
RETURN VARCHAR2;
Accepts a policy name and a single VARCHAR2 document
Overload 1
ctx_doc.policy_stems(
policy_name IN VARCHAR2,
document IN VARCHAR2,
restab IN OUT NOCOPY stem_group_tab,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single CLOB document
Overload 2
ctx_doc.policy_stems(
policy_name IN VARCHAR2,
document IN CLOB,
restab IN OUT NOCOPY stem_group_tab,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
Accepts a policy name and a single VARCHAR2 document
Overload 1
ctx_doc.policy_themes(
policy_name IN VARCHAR2,
document IN VARCHAR2,
restab IN OUT NOCOPY theme_tab,
full_themes IN BOOLEAN DEFAULT FALSE,
num_themes IN NUMBER DEFAULT 50,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single CLOB document
Overload 2
ctx_doc.policy_themes(
policy_name IN VARCHAR2,
document IN CLOB,
restab IN OUT NOCOPY theme_tab,
full_themes IN BOOLEAN DEFAULT FALSE,
num_themes IN NUMBER DEFAULT 50,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single BLOB document
Overload 3
ctx_doc.policy_themes(
policy_name IN VARCHAR2,
document IN BLOB,
restab IN OUT NOCOPY theme_tab,
full_themes IN BOOLEAN DEFAULT FALSE,
num_themes IN NUMBER DEFAULT 50,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
TBD
Accepts a policy name and a single BFILE document
Overload 4
ctx_doc.policy_themes(
policy_name IN VARCHAR2,
document IN BFILE,
restab IN OUT NOCOPY theme_tab,
full_themes IN BOOLEAN DEFAULT FALSE,
num_themes IN NUMBER DEFAULT 50,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL);
Accepts a policy name and a single VARCHAR2 document
Overload 1
ctx_doc.policy_tokens(
policy_name IN VARCHAR2,
document IN VARCHAR2,
restab IN OUT NOCOPY token_tab,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
thes_name IN VARCHAR2 DEFAULT NULL,
thes_toktype IN VARCHAR2 DEFAULT ctx_doc.thes_dflt_tok);
TBD
Accepts a policy name and a single CLOB document
Overload 2
ctx_doc.policy_tokens(
policy_name IN VARCHAR2,
document IN CLOB,
restab IN OUT NOCOPY token_tab,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
thes_name IN VARCHAR2 DEFAULT NULL,
thes_toktype IN VARCHAR2 DEFAULT ctx_doc.thes_dflt_tok);
TBD
Accepts a policy name and a single BLOB document
Overload 3
ctx_doc.policy_tokens(
policy_name IN VARCHAR2,
document IN BLOB,
restab IN OUT NOCOPY token_tab,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
thes_name IN VARCHAR2 DEFAULT NULL,
thes_toktype IN VARCHAR2 DEFAULT ctx_doc.thes_dflt_tok);
TBD
Accepts a policy name and a single BFILE document
Overload 4
ctx_doc.policy_tokens(
policy_name IN VARCHAR2,
document IN BFILE,
restab IN OUT NOCOPY token_tab,
language IN VARCHAR2 DEFAULT NULL,
format IN VARCHAR2 DEFAULT NULL,
charset IN VARCHAR2 DEFAULT NULL,
thes_name IN VARCHAR2 DEFAULT NULL,
thes_toktype IN VARCHAR2 DEFAULT ctx_doc.thes_dflt_tok);
Writes the text segments analyzed and their respective sentiment scores for the given topic IN a result table
ctx_doc.sentiment(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
topic IN VARCHAR2,
restab IN VARCHAR2,
clsfier_name IN VARCHAR2 DEFAULT NULL,
ttype IN VARCHAR2 DEFAULT ctx_doc.sent_dflt_type,
radius IN NUMBER DEFAULT ctx_doc.sent_dflt_radius,
max_inst IN NUMBER DEFAULT ctx_doc.sent_dflt_maxinst,
starttag IN VARCHAR2 DEFAULT ctx_doc.sent_dflt_starttag,
endtag IN VARCHAR2 DEFAULT ctx_doc.sent_dflt_endtag,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback);
Returns the aggregate sentiment score for the specified document and given topic if any
ctx_doc.sentiment_aggregate(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
topic IN VARCHAR2 DEFAULT NULL,
clsfier_name IN VARCHAR2 DEFAULT NULL,
ttype IN VARCHAR2 DEFAULT ctx_doc.sent_dflt_type,
radius IN NUMBER DEFAULT ctx_doc.sent_dflt_radius,
max_inst IN NUMBER DEFAULT ctx_doc.sent_dflt_maxinst,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback)
RETURN NUMBER;
Accepts a index name and a key to specify a document
ctx_doc.snippet(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
text_query IN VARCHAR2,
starttag IN VARCHAR2 DEFAULT '<b>',
endtag IN VARCHAR2 DEFAULT '</b>',
entity_translation IN BOOLEAN DEFAULT TRUE,
separator IN VARCHAR2 DEFAULT '<b>...</b>',
radius IN NUMBER DEFAULT 25,
max_length IN NUMBER DEFAULT 250,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback)
RETURN VARCHAR2;
Accepts a index name and a key to specify a document
ctx_doc.snippet_clob_query(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
text_query IN CLOB,
starttag IN VARCHAR2 DEFAULT '<b>',
endtag IN VARCHAR2 DEFAULT '</b>',
entity_translation IN BOOLEAN DEFAULT TRUE,
separator IN VARCHAR2 DEFAULT '<b>...</b>',
radius IN NUMBER DEFAULT 25,
max_length IN NUMBER DEFAULT 250,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback)
RETURN VARCHAR2;
Generate the themes for a given document. The themes will be written to the theme table specified. The theme table must have the following column.
Overload 1
ctx_doc.themes(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
restab IN VARCHAR2,
query_id IN NUMBER DEFAULT 0,
full_themes IN BOOLEAN DEFAULT FALSE,
num_themes IN NUMBER DEFAULT 50,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback);
TBD
Returns the results into a PL/SQL table instead of a result table
Overload 2
ctx_doc.themes(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
restab IN OUT NOCOPY theme_tab,
full_themes IN BOOLEAN DEFAULT FALSE,
num_themes IN NUMBER DEFAULT 50,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback);
Generate the tokens for a given document. The tokens are written to the specified token table.
Overload 1
ctx_doc.tokens(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
restab IN VARCHAR2,
query_id IN NUMBER DEFAULT 0,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback,
thes_name IN VARCHAR2 DEFAULT NULL,
thes_toktype IN VARCHAR2 DEFAULT ctx_doc.thes_dflt_tok);
TBD
Returns the results into a PL/SQL table instead of a result table
Overload 2
ctx_doc.tokens(
index_name IN VARCHAR2,
textkey IN VARCHAR2,
restab IN OUT NOCOPY token_tab,
use_saved_copy IN NUMBER DEFAULT ctx_doc.save_copy_fallback,
thes_name IN VARCHAR2 DEFAULT NULL,
thes_toktype IN VARCHAR2 DEFAULT ctx_doc.thes_dflt_tok);