ページ結果
post
/srt/api/v1/search/pagination
このメソッドは、現在の結果セットから検索結果の新しいページを返します。 現在の結果セットには、検索構成で定義された結果の最大数が含まれます。
URIの例
このメソッドのURIの例は、次のとおりです:
-
http://<SEARCH_REST_API_HOST>/srt/api/v1/search/pagination?priorTransactionId=12345&purposeName=ANSWER&pageDirection=next&pageNumber=0
このリクエストは、指定されたトランザクションIDに対する回答のページ区切りリストを返します。 リストは、前のトランザクションIDおよび目的名に従ってページ区切りされます。 ページの方向が次へに設定され、ページ番号が0に設定されると、ページ区切りリスト内の回答はページ番号0から開始し、最後の結果ページまで次のページに進みます。
レスポンス・エラー
このメソッドの考えられるエラー・レスポンスは次のとおりです:
- OK-GEN0003
リクエストURLに指定された問合せパラメータが無効または空の場合にエラーが発生します。
リクエスト
サポートされるメディア・タイプ
- application/json
- application/xml
問合せパラメータ
- newPageSize(optional): integer
整数値。ページに必要な結果の数。
- pageDirection: string
pageDirectionには、ユーザーが前後にナビゲートしているかどうかに応じて、可能なかぎり次と前の値を指定できます
- pageNumber(optional): integer
0から始まる現在のページ番号を含む整数値
- priorTransactionId: integer
このIDは、現在の結果セットに関連しています。 これには、表示された結果と、検索結果の最大数までの結果が含まれます(検索構成で定義)。 ページ区切りまたはナビゲーションのリクエストの場合、ページ区切りまたはナビゲーションは現在の結果セットにのみ適用され、新しい結果は取得されません。
- purposeName: string
目的名は結果のコンポーネントを示します。 検索結果は目的'ANSWER'を使用します。 指定可能な値は、TOOLTIP、FEATURE_CONTENTです。
セッションの内容を格納するセッション・オブジェクト。
ルート・スキーマ : SearchSession
タイプ:
object
タイトル:
ソースを表示
SearchSession
- baseURL(optional): string
ベースURL
- ccaInfo(optional): object CCAInfo
タイトル:
CCAInfo
- clientInfo(optional): object ClientInfo
タイトル:
ClientInfo
- domainGroup(optional): string
このリクエストに使用するドメイン・グループ
- facetPriorTransactionId(optional): integer
ファセットを保持するために、以前のトランザクションのtransactionIdから設定されたID。 このIDの値を同じセッションの前のトランザクションのtransactionIdに設定して、前のトランザクションで選択されたファセットを保持できます。 startOverFlagの値をfalseに設定するか、フラグを省略する必要があります。 フラグを省略すると、デフォルトでfalseになります。 最新のトランザクションのtransactionIdsまたは履歴の以前の5つのトランザクションを使用して、現在のトランザクションのfacetPriorTransactionIdを設定できます。 facetPriorTransactionIdは、 /questionエンドポイントにのみ適用されることに注意してください。
- isDeflection(optional): boolean
このリクエストは無視しようとしているか
- locale(optional): string
リクエストのロケール
- navigationApplicationId(optional): string
- pageSize(optional): integer
このページの最大結果数
- querySource(optional): string
このリクエストの問合せソース
- requestSource(optional): string
要求ソース
- resultLocales(optional): string
目的の結果のロケールのカンマ区切りリスト
- segment(optional): string
このリクエストに関連付ける分析セグメント
- session(optional): string
セッション・ノード
- subject(optional): string
このリクエストに使用する件名/垂直
- transactionId(optional): integer
TransactionId
- uiMode(optional): string
このリクエストのUIモード
ネストされたスキーマ : CCAInfo
タイプ:
object
タイトル:
ソースを表示
CCAInfo
- answerSolutionList(optional): string
回答解決策リスト
- caseDescription(optional): string
ケース説明
- connected(optional): boolean
接続しました
- contentIds(optional): string
ContentIds
- extSolutionList(optional): string
外部解決策リスト
- name(optional): string
名前
- SRKey(optional): 文字列
SRKey
- system(optional): string
システム
- types(optional): string
タイプ
ネストされたスキーマ : ClientInfo
タイプ:
object
タイトル:
ソースを表示
ClientInfo
- address(optional): string
Address
- agentAddress(optional): string
エージェント・アドレス
- cookies(optional): string
Cookies
- extSessionId(optional): string
外部セッションID
- host(optional): string
ホスト
- referrer(optional): string
リファラURL
- requestAttributes(optional): array requestAttributes
マップ・エントリのリスト
- requestHeaders(optional): array requestHeaders
マップ・エントリのリスト
- requestParameters(optional): array requestParameters
マップ・エントリのリスト
ネストされたスキーマ : requestAttributes
タイプ:
array
マップ・エントリのリスト
ソースを表示
- Array of: object MapEntry
タイトル:
MapEntry
ネストされたスキーマ : requestParameters
タイプ:
array
マップ・エントリのリスト
ソースを表示
- Array of: object MapEntry
タイトル:
MapEntry
レスポンス
サポートされるメディア・タイプ
- application/json
- application/xml
200 レスポンス
「OK」をクリックします。
ルート・スキーマ : GIML
タイプ:
object
タイトル:
ソースを表示
GIML
- constraints(optional): object SearchConstraints
タイトル:
SearchConstraints
- priorTransactionId(optional): integer
以前のTransactionId
- query(optional): object Query
タイトル:
Query
- results(optional): object RequestResult
タイトル:
RequestResult
- session(optional): string
セッション・ノード
- transactionId(optional): integer
TransactionId
ネストされたスキーマ : SearchConstraints
タイプ:
object
タイトル:
ソースを表示
SearchConstraints
- baseURL(optional): string
SearchConstraintsオブジェクトのBaseURL
- domainGroup(optional): string
SearchConstraintsオブジェクトのDomainGroup
- language(optional): string
SearchConstraintsオブジェクトの言語
- navigationApplicationId(optional): string
- querySource(optional): string
SearchConstraintsオブジェクトのQuerySource
- requestSource(optional): string
SearchConstraintsオブジェクトのRequestSource
- resultLanguages(optional): string
SearchConstraintsオブジェクトのResultLanguages
- segment(optional): string
SearchConstraintsオブジェクトのセグメント
- subject(optional): string
SearchConstraintsオブジェクトの件名
- uiMode(optional): string
SearchConstraintsオブジェクトのUiMode
ネストされたスキーマ : 問合せ
タイプ:
object
タイトル:
ソースを表示
Query
- interactive(optional): boolean
対話型スペル・チェック有効
- original(optional): string
元の質問
- paraphrase(optional): string
パラフレーズ質問
- spellchecked(optional): object Spellchecked
タイトル:
Spellchecked
ネストされたスキーマ : RequestResult
タイプ:
object
タイトル:
ソースを表示
RequestResult
- facets(optional): array facets
子ファセットと多数の関係
- message(optional): string
- messageCode(optional): string
- results(optional): array results
textElementsのリスト
ネストされたスキーマ : スペル・チェック済
タイプ:
object
タイトル:
ソースを表示
Spellchecked
- corrections(optional): array corrections
SuggestionBOのリスト
ネストされたスキーマ : ファセット
タイプ:
array
子ファセットと多数の関係
ソースを表示
- Array of: object FacetResultNode
タイトル:
FacetResultNode
ネストされたスキーマ : 結果
タイプ:
array
textElementsのリスト
ソースを表示
- Array of: object ComponentResult
タイトル:
ComponentResult
ネストされたスキーマ : FacetResultNode
タイプ:
object
タイトル:
ソースを表示
FacetResultNode
- children(optional): array children
子ファセットと多数の関係
- count(optional): integer
FacetResultNodeオブジェクトのFacetResultNode
- desc(optional): string
FacetResultNodeオブジェクトのFacetResultNode
- id(optional): string
FacetResultNodeオブジェクトのFacetResultNode
- incomplete(optional): boolean
FacetResultNodeオブジェクトのFacetResultNode
- inEffect(optional): boolean
FacetResultNodeオブジェクトのFacetResultNode
- showLink(optional): boolean
FacetResultNodeオブジェクトのFacetResultNode
- tempSelect(optional): boolean
FacetResultNodeオブジェクトのFacetResultNode
ネストされたスキーマ : 子供
タイプ:
array
子ファセットと多数の関係
ソースを表示
- Array of: object FacetResultNode
タイトル:
FacetResultNode
ネストされたスキーマ : resultItems
タイプ:
array
textElementsのリスト
ソースを表示
- Array of: object ResultItem
タイトル:
ResultItem
ネストされたスキーマ : ResultItem
タイプ:
object
タイトル:
ソースを表示
ResultItem
- answerId(optional): integer
この回答のID
- clickThroughLink(optional): string
URLには、検索結果がContent(IM)ファイル添付の場合、元のエンコーディングのファイル名が含まれます。 それ以外の場合、値はURLパラメータ値と同じです。
- dateModified(optional): string(date-time)
記事が最後に変更された日付
- docId(optional): integer
この回答に対応するドキュメントのID
- fileType(optional): string
結果アイテムの取得元ファイルのタイプ(該当する場合)
- globalAnswerId(optional): string
この回答のグローバルAnswerId
- highlightedLink(optional): string
- link(optional): string
- relatedIds(optional): array relatedIds
- rule(optional): string
結果アイテムのルール
- score(optional): number
- similarResponseLink(optional): string
- textElements(optional): array textElements
textElementsのリスト
- title(optional): object TextElement
タイトル:
TextElement
- type(optional): string
結果アイテムのタイプ
ネストされたスキーマ : textElements
タイプ:
array
textElementsのリスト
ソースを表示
- Array of: object TextElement
タイトル:
TextElement
ネストされたスキーマ : TextElement
タイプ:
object
タイトル:
ソースを表示
TextElement
- snippets(optional): array snippets
- type(optional):
許可された値:
[ "UNSTRUCTURED", "STRUCTURED", "STRING", "URL", "HTML" ]
テキスト要素タイプ文字列、URL、HTML - url(optional): string
例
次の例は、cURLを使用してRESTリソースに対する投稿リクエストを発行することによって、現在の結果セットから検索結果の新しいページを作成する方法を示しています。
cURLコマンド
curl -X POST "https://<SEARCH_REST_API_HOST>/srt/api/latest/search/pagination" -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" } ] } }
レスポンス本文の例
次に、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 }