1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Key Terms v1
  4. Prompts v1
  5. Test Results v1
  6. Citations v1

Get a citation for a keyterm prompt test result using advanced query

post

/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/keyterms/{keyterms_id}/prompts/{keyterms-prompts_id}/testResults/{keyterms-prompts-testResults_id}/citations/{keyterms-prompts-testResults-citations_id}/$query

Request

Path Parameters
Query Parameters
  • The effective date value in ISO 8601 date format 'YYYY-MM-DD'. This date is required by business logic to search for effective-dated business objects.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • accessors
    Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
  • fields
    Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
  • subTypes
    Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.
Nested Schema : accessors
Type: object
Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
Nested Schema : fields
Type: array
Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
Show Source
Nested Schema : subTypes
Type: object
Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.
Back to Top

Response

Default Response

A single item response
Body ()
Root Schema : keyterms-prompts-testResults-citations_item-response
Match All
Show Source
Nested Schema : oraCxSalesCommonKeyterms.PromptTestCitation_item
Match All
Citation is the part of the source document that's referenced by the large language model to get a response.
Show Source
Nested Schema : oraCxSalesCommonKeyterms.PromptTestCitation_item-fields
Type: object
Show Source
Nested Schema : Citation
Type: object
Title: Citation
Citation is the part of the source document that's referenced by the large language model to get a response.
Nested Schema : __busObj_context
Type: object
Show Source
Nested Schema : testResult
Match All
Show Source
Nested Schema : oraCxSalesCommonKeyterms.PromptTestResult_item
Match All
Prompt test result includes information about the response provided by the large language model for a specific prompt.
Show Source
Nested Schema : oraCxSalesCommonKeyterms.PromptTestResult_item-fields
Type: object
Show Source
Nested Schema : Prompt Test Result
Type: object
Title: Prompt Test Result
Prompt test result includes information about the response provided by the large language model for a specific prompt.
Nested Schema : testResult-allOf[2]
Type: object
Nested Schema : prompt
Match All
Show Source
Nested Schema : oraCxSalesCommonKeyterms.KeytermPrompt_item
Match All
Key term prompt is the question that's used in a large language model to extract a certain key term from contract documents.
Show Source
Nested Schema : oraCxSalesCommonKeyterms.KeytermPrompt_item-fields
Type: object
Show Source
Nested Schema : Key Term Prompt
Type: object
Title: Key Term Prompt
Key term prompt is the question that's used in a large language model to extract a certain key term from contract documents.
Nested Schema : prompt-allOf[2]
Type: object
Nested Schema : keyterm
Match All
Show Source
Nested Schema : status
Match All
Show Source
  • Title: Status
    Default Value: ORA_OKC_DRAFT
  • Allowed Values: [ "ORA_OKC_DRAFT", "ORA_OKC_ACTIVE", "ORA_OKC_INACTIVE" ]
Nested Schema : oraCxSalesCommonKeyterms.Keyterm_item
Match All
Key term is the metadata present in the contract documents. The key terms to be extracted for each contract type is defined in the application with the corresponding prompts to be used for extraction.
Show Source
Nested Schema : oraCxSalesCommonKeyterms.Keyterm_item-fields
Type: object
Show Source
Nested Schema : Key Term
Type: object
Title: Key Term
Key term is the metadata present in the contract documents. The key terms to be extracted for each contract type is defined in the application with the corresponding prompts to be used for extraction.
Nested Schema : keyterm-allOf[2]
Type: object
Nested Schema : group
Match All
Show Source
Nested Schema : outputType
Match All
Show Source
  • Title: Output Type
  • Allowed Values: [ "ORA_OKC_TEXT", "ORA_OKC_NUMBER", "ORA_OKC_DATE" ]
Nested Schema : oraCxSalesCommonKeyterms.KeytermGroupLookup_item-fields
Match All
Show Source
Nested Schema : oraCommonAppsInfraObjects.LookupCode_abstract-item
Type: object
Show Source
Nested Schema : oraCxSalesCommonKeyterms.KeytermGroupLookup_item-fields-allOf[1]
Type: object
Show Source
Nested Schema : Group
Type: object
Title: Group
Nested Schema : $context
Type: object
Show Source
Nested Schema : links
Type: object
Read Only: true
Show Source
Nested Schema : $self
Type: object
Show Source
Links
self
Parameters:
  • keyterms-prompts-testResults-citations_id: $request.path.keyterms-prompts-testResults-citations_id
  • keyterms-prompts-testResults_id: $request.path.keyterms-prompts-testResults_id
  • keyterms-prompts_id: $request.path.keyterms-prompts_id
  • keyterms_id: $request.path.keyterms_id
testResult
Parameters:
  • promptTestResults_id: $response.body#/testResult/$id
Back to Top

Examples

The following example shows how to advanced query a citation for a keyterm prompt test result by submitting a post request on the REST resource using cURL.

cURL Command

curl -X POST --location 'https://<servername>/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/$en/keyterms/{keyterms_id}/prompts/{keyterms-prompts_id}/testResults/{keyterms-prompts-testResults_id}/citations/{keyterms-prompts-testResults-citations_id}/$query' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <token>' -D request.json

Example of Request Body

The following shows an example of the request body in JSON format.

{
    "fields": [
        "id",
        "sequenceNumber",
        "citation",
        "createdBy",
        "timeCreated",
        "updatedBy",
        "timeUpdated"
    ]
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "id": "300100626058688",
    "sequenceNumber": "1",
    "citation": "\nA. Terms of The Order\n\n1. Applicable Agreement:\n\na. Cloud Services Agreement SA-PRC-9341 effective 21-Jan-2018\n\n2. Payment Terms:\n\na. Net 30 days from invoice date\n\n3. Payment Frequency:\n\na. Monthly in Advance\n\n4. Currency:\n\na. USD\n\n5. Offer Valid through:\n\na. 30-Jun-2024\n\n6. Services Period\n\nYour Subscription commences on the effective date of the Order unless otherwise specified therein. Your Subscription continues for the Initial Subscription Term stated in the Order. Thereafter, each Subscription will automatically renew for successive periods of 12 months (each a ?Renewal Term?) unless a party gives at least 30 days? prior written notice to the other party of its intention not to renew the Subscription. Unless otherwise agreed in the applicable Order, and subject to Your rights to terminate under this Section, Your Subscription may only be terminated in accordance with clause B.\n\nB. Additional Terms",
    "createdBy": "CONMGR",
    "timeCreated": "2025-01-15T10:11:12.771824Z",
    "updatedBy": "CONMGR",
    "timeUpdated": "2025-01-15T10:11:12.771824Z",
    "$id": "300100626058688",
    "$context": {
        "etag": "1",
        "links": {
            "$self": {
                "href": "https://cptbbybqy-test.fusionapps.ocs.oc-test.com:443/api/boss/data/objects/ora/cxSalesCommon/keyterms/v1/$en/keyterms/ATS_JLSA_Renewal_Cap_Percentage/prompts/300100626058682/testResults/300100626058685/citations/300100626058688"
            }
        }
    }
}
Back to Top