機械翻訳について
  1. Oracle Fusionサービスでのナレッジ管理のREST API
  2. タスク
  3. 検索
  4. 検索

質問

post

/srt/api/v1/search/question

このメソッドは、指定された質問の一連の検索結果を返します。

URIの例

このメソッドのURIの例は、次のとおりです:

  • http://<SEARCH_REST_API_HOST>/srt/api/v1/search/question?question=how+do+i+upgrade+my+device

    リクエストは、指定された質問の一連の検索結果を返します。

  • http://<SEARCH_REST_API_HOST>/srt/api/v1/search/question?question=how+do+i+upgrade+my+device&facet=Collections.OKKB-FAQ

    リクエストは、指定されたcontent-type、FAQの一連の事前フィルタ済検索結果を返します。

  • http://<SEARCH_REST_API_HOST>/srt/api/v1/search/question?question=how+do+i+upgrade+my+device&facet=CMS-PRODUCT.RN_PRODUCT_1,CMS-PRODUCT.RN_PRODUCT_2&multiFacets=OR

    このリクエストは、指定された製品RN_PRODUCT_1またはRN_PRODUCT_2に対して事前にフィルタリングされた検索結果のセットを返します。

レスポンス・エラー

このメソッドの考えられるエラー・レスポンスは次のとおりです:

  • OK-GEN0003

    リクエストURLに指定された問合せパラメータが無効または空の場合にエラーが発生します。

セッション・オブジェクト

セッション・オブジェクトは、トランザクションのセッション情報を格納します。 セッション情報には、現在の結果セット、ページ・トラッキングおよびナビゲーション・アクティビティに関する情報が含まれます。 実装エージェントは、後続のリクエストごとに、実行時にセッション情報を格納して返す必要があります。

ファセット

ファセットは、コンテンツを分類する方法です。 これらは、情報を分類して検索機能を強化するのに役立ちます。 ファセット・ベースの検索では、情報の検索中に複数のフィルタを適用できます。 Information Mangerコンソールの作成者である場合は、割り当てられたカテゴリを参照して、カテゴリをコンテンツに割り当て、コンテンツに割り当てられているファセットを検索できます。

リクエスト

サポートされるメディア・タイプ
問合せパラメータ
  • 検索結果を絞り込むために使用するファセットまたはカテゴリ。 推奨されるファセットの最大数は12です。
  • 新しく追加されたmultiFacetsパラメータが渡されていないか、値が設定されていない場合、APIの下位互換性を確保するために、同じファセット・タイプの最後のファセットが使用されます。
  • 整数値。ページに必要な結果の数。
  • 尋ねられた質問または検索made(by the end user)。
  • 検索状態を最初から完全に開始するようにリセットする必要があります。
本文( )
セッションの内容を格納するセッション・オブジェクト。
ルート・スキーマ : SearchSession
タイプ: object
タイトル: SearchSession
ソースを表示
ネストされたスキーマ : CCAInfo
タイプ: object
タイトル: CCAInfo
ソースを表示
ネストされたスキーマ : ClientInfo
タイプ: object
タイトル: ClientInfo
ソースを表示
ネストされたスキーマ : requestAttributes
タイプ: array
マップ・エントリのリスト
ソースを表示
ネストされたスキーマ : requestHeaders
タイプ: array
マップ・エントリのリスト
ソースを表示
ネストされたスキーマ : requestParameters
タイプ: array
マップ・エントリのリスト
ソースを表示
ネストされたスキーマ : MapEntry
タイプ: object
タイトル: MapEntry
ソースを表示
トップに戻る

レスポンス

サポートされるメディア・タイプ

200 レスポンス

「OK」をクリックします。
本文( )
ルート・スキーマ : GIML
タイプ: object
タイトル: GIML
ソースを表示
ネストされたスキーマ : SearchConstraints
タイプ: object
タイトル: SearchConstraints
ソースを表示
ネストされたスキーマ : 問合せ
タイプ: object
タイトル: Query
ソースを表示
ネストされたスキーマ : RequestResult
タイプ: object
タイトル: RequestResult
ソースを表示
ネストされたスキーマ : スペル・チェック済
タイプ: object
タイトル: Spellchecked
ソースを表示
ネストされたスキーマ : 修正
タイプ: array
SuggestionBOのリスト
ソースを表示
ネストされたスキーマ : 訂正
タイプ: object
タイトル: Correction
ソースを表示
ネストされたスキーマ : 提案
タイプ: array
SuggestionBOのリスト
ソースを表示
ネストされたスキーマ : 提案
タイプ: object
タイトル: Suggestion
ソースを表示
ネストされたスキーマ : ファセット
タイプ: array
子ファセットと多数の関係
ソースを表示
ネストされたスキーマ : 結果
タイプ: array
textElementsのリスト
ソースを表示
ネストされたスキーマ : FacetResultNode
タイプ: object
タイトル: FacetResultNode
ソースを表示
ネストされたスキーマ : 子供
タイプ: array
子ファセットと多数の関係
ソースを表示
ネストされたスキーマ : ComponentResult
タイプ: object
タイトル: ComponentResult
ソースを表示
ネストされたスキーマ : resultItems
タイプ: array
textElementsのリスト
ソースを表示
ネストされたスキーマ : ResultItem
タイプ: object
タイトル: ResultItem
ソースを表示
ネストされたスキーマ : relatedIds
タイプ: array
この回答に関連する回答のIDのリスト
ソースを表示
ネストされたスキーマ : textElements
タイプ: array
textElementsのリスト
ソースを表示
ネストされたスキーマ : TextElement
タイプ: object
タイトル: TextElement
ソースを表示
ネストされたスキーマ : スニペット
タイプ: array
ソースを表示
ネストされたスキーマ : スニペット
タイプ: object
タイトル: Snippet
ソースを表示
トップに戻る

例

次の例は、cURLを使用してRESTリソースに対するポスト・リクエストを発行して、リポジトリに質問を作成する方法を示しています。

cURLコマンド

curl -X POST "https://<SEARCH_REST_API_HOST>/srt/api/latest/search/question" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json" -d "@<FilePath/RequestBody.json>"

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
  "session" : "SESSION_VALUE",
  "transactionId" : -470886747,
  "facetPriorTransactionId" : 0,
  "baseURL" : "BASEURL_VALUE",
  "locale" : "LOCALE_VALUE",
  "resultLocales" : "RESULTLOCALES_VALUE",
  "domainGroup" : "DOMAINGROUP_VALUE",
  "navigationApplicationId" : "NAVIGATIONAPPLICATIONID_VALUE",
  "segment" : "SEGMENT_VALUE",
  "querySource" : "QUERYSOURCE_VALUE",
  "uiMode" : "UIMODE_VALUE",
  "requestSource" : "REQUESTSOURCE_VALUE",
  "subject" : "SUBJECT_VALUE",
  "isDeflection" : true,
  "clientInfo" : {
    "agentAddress" : "AGENTADDRESS_VALUE",
    "extSessionId" : "EXTSESSIONID_VALUE",
    "referrer" : "REFERRER_VALUE",
    "cookies" : "COOKIES_VALUE",
    "address" : "ADDRESS_VALUE",
    "host" : "HOST_VALUE",
    "requestHeaders" : [ {
      "key" : "KEY_VALUE",
      "value" : "VALUE_VALUE"
    } ],
    "requestParameters" : [ {
      "key" : "KEY_VALUE",
      "value" : "VALUE_VALUE"
    } ],
    "requestAttributes" : [ {
      "key" : "KEY_VALUE",
      "value" : "VALUE_VALUE"
    } ]
  }
}

例1 レスポンス本文

次に、検索結果が質問と一致する場合のJSON形式のレスポンス本文の例を示します。

{
  "constraints" : {
    "baseURL" : "BASEURL_VALUE",
    "language" : "LANGUAGE_VALUE",
    "resultLanguages" : "RESULTLANGUAGES_VALUE",
    "domainGroup" : "DOMAINGROUP_VALUE",
    "navigationApplicationId" : "NAVIGATIONAPPLICATIONID_VALUE",
    "segment" : "SEGMENT_VALUE",
    "querySource" : "QUERYSOURCE_VALUE",
    "uiMode" : "UIMODE_VALUE",
    "requestSource" : "REQUESTSOURCE_VALUE",
    "subject" : "SUBJECT_VALUE"
  },
  "results" : {
    "results" : [ {
      "name" : "NAME_VALUE",
      "pageNumber" : 119012499,
      "pageMore" : -1787984382,
      "pageStart" : 1011298310,
      "score" : 0.8950256205517777,
      "pageSize" : -356445925,
      "unshownResults" : -567000158,
      "totalResults" : 964064210,
      "resultItems" : [ {
        "rule" : "RULE_VALUE",
        "type" : "TYPE_VALUE",
        "fileType" : "FILETYPE_VALUE",
        "answerId" : -2113305261,
        "docId" : -1406261280,
        "score" : 0.0,
        "title" : {
          "url" : "URL_VALUE",
          "type" : "HTML",
          "snippets" : [ {
            "text" : "TEXT_VALUE",
            "level" : 1829155447
          } ]
        },
        "link" : "LINK_VALUE",
        "clickThroughLink" : "CLICKTHROUGHLINK_VALUE",
        "similarResponseLink" : "SIMILARRESPONSELINK_VALUE",
        "highlightedLink" : "HIGHLIGHTEDLINK_VALUE",
        "textElements" : [ {
          "url" : "URL_VALUE",
          "type" : "UNSTRUCTURED",
          "snippets" : [ {
            "text" : "TEXT_VALUE",
            "level" : -1117285219
          } ]
        } ]
      } ]
    } ]
  },
  "session" : "SESSION_VALUE",
  "transactionId" : -1551467838,
  "priorTransactionId" : 28680311
}

例2 レスポンス本文

次に、尋ねられた質問に一致するコンテンツがない場合のJSON形式のレスポンス本文の例を示します。

{
    "results": {
        "results": [],
        "facets": []
    },
    "query": {
        "interactive": false,
        "original": "file",
        "paraphrase": "file"
    },
}

例3 レスポンス本文

次は、検索に使用可能なデータがない場合にJSON形式のレスポンス本文の例を示しています。

{
    "error": {
        "title": "An application error has occurred. Root Cause: <exception>: OK-SRCH0002 - No Index Data Found.",
        "errorCode": "OK-GEN0003",
        "type": "APPLICATION"
    },
    "errorDetails": [
        {
            "title": "No Index Data Found.",
            "errorCode": "OK-SRCH0002",
            "type": "APPLICATION"
        }
    ]
}

例4 レスポンス本文

次に、ナレッジ検索が正しく実行されない場合のJSON形式のレスポンス本文の例を示します。

{
  "error" : {
    "title" : "An application error has occurred. Root Cause: <exception>: Unable to decrypt string",
    "errorCode" : "OK-GEN0003",
    "type" : "APPLICATION"
  },
  "errorDetails" : [ ]
}
「トップに戻る」