回答
post
/srt/api/v1/search/answer
このメソッドは、回答結果のクリックのレコードを返します。文が強調表示され、検索問合せに一致するセクションを検索するのに役立ちます。 このメソッドでは、分析および請求の目的で、クリックスルURI、強調表示されたドキュメントおよびアクション・トラッキングも提供されます。 検索リクエストのすべてのパラメータは必須値です。
URIの例
このメソッドのURIの例は、次のとおりです:
http://<SEARCH_REST_API_HOST>/srt/api/v1/search/answer?priorTransactionId=12345&answerId=16777216&trackClickFlag=true&highlightFlag=true
リクエストにより、指定したトランザクションIDの回答結果のクリック数レコードが提供されます。 結果リストが表示され、文が強調表示されます。
リクエスト
サポートされるメディア・タイプ
- application/json
- application/xml
問合せパラメータ
- answerId: integer
ユーザーがクリックした回答のID
- highlightFlag: boolean
返された回答に対してサービスが文を強調表示するかどうか。
- highlightInfo(optional): string
highlightInfo
- pdfFlag(optional): boolean
pdfFlag
- priorTransactionId: integer
このIDは、現在の結果セットに関連しています。 これには、表示された結果と、検索結果の最大数までの結果が含まれます(検索構成で定義)。 ページ区切りまたはナビゲーションのリクエストの場合、ページ区切りまたはナビゲーションは現在の結果セットにのみ適用され、新しい結果は取得されません。
- trackClickFlag: boolean
サービスがクリックを追跡するかどうか。
- trackedUrl(optional): string
トラッキングする必要がある正確なURL
- unstructuredFlag(optional): boolean
unstructuredFlag
セッションの内容を格納するセッション・オブジェクト。
ルート・スキーマ : 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」をクリックします。
ルート・スキーマ : メッセージ
タイプ:
object
タイトル:
ソースを表示
Message
- documentType(optional): string
回答文書タイプ
- HttpPassThrough(optional): 文字列
HttpPassthrough
- priorTransactionId(optional): integer
以前のTransactionId
- session(optional): string
セッション・ノード
- title(optional): string
回答タイトル
- transactionId(optional): integer
TransactionId
- url(optional): string
Answer URL
例
次の例は、cURLを使用してRESTリソースに対する投稿リクエストを発行することによって、センテンスを強調表示して、回答結果のクリック・レコードを作成する方法を示しています。
cURLコマンド
curl -X POST "https://<SEARCH_REST_API_HOST>/srt/api/latest/search/answer" -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形式のレスポンス本文の例を示します。
{ "results":{ "results": [ { "name":"ANSWER", "pageNumber": 0, "pageMore": 0, "pageStart": 0, "score": 0.967448890209198, "pageSize": 2, "unshownResults": 0, "totalResults": 2, "resultItems": [ { "type":"unstructured", "fileType":"CMS-XML", "answerId": 16777216, "globalAnswerId":"1005005", "docId": 25165876, "score": 0.967448890209198, "title":{ "url":"URL_VALUE", "type":"STRING", "snippets": [ { "text":" Replacing the Keyboard on a LS 1500 ", "level": 0 } ], }, "dateModified":"2018-06-04T16:20:28+0000", "link":"LINK_VALUE", "clickThroughLink":"CLICKTHROUGHLINK_VALUE", "textElements": [ { "type":"STRING", "snippets": [ { "text":" TEXT_VALUE", "level": 0 } ], } ], }, { "type":"unstructured", "fileType":"CMS-XML", "answerId": 16777217, "globalAnswerId":"1004005", "docId": 25165872, "score": 0.9649738669395447, "title":{ "url":"URL_VALUE, "type":"STRING", "snippets": [ { "text":" TEXT_VALUE", "level": 0 } ], }, "dateModified":"2018-06-04T16:12:05+0000", "link":"LINK_VALUE", "clickThroughLink":"CLICKTHROUGHLINK_VALUE", "textElements": [ { "type":"STRING", "snippets": [ { "text":" TEXT_VALUE", "level": 0 } ], } ], } ], } ], "facets": [ { "id":"DOC_TYPES", "desc":"Document Types", "count": 2, "inEffect": false, "incomplete": false, "showLink": true, "tempSelect": false, "children": [ { "id":"DOC_TYPES.CMS-XML", "desc":"Article", "count": 2, "inEffect": false, "incomplete": false, "showLink": true, "tempSelect": false, "children": [ ], } ], }, { "id":"COLLECTIONS", "desc":"Collections", "count": 2, "inEffect": false, "incomplete": false, "showLink": true, "tempSelect": false, "children": [ { "id":"COLLECTIONS.OKKB-FAQ", "desc":"FAQ", "count": 2, "inEffect": false, "incomplete": false, "showLink": true, "tempSelect": false, "children": [ ], } ], }, { "id":"CMS-PRODUCT", "desc":"Products", "count": 2, "inEffect": false, "incomplete": false, "showLink": true, "tempSelect": false, "children": [ { "id":"CMS-PRODUCT.FUSION_PRODUCT_999997826069849", "desc":"Vision Catalog", "count": 2, "inEffect": false, "incomplete": false, "showLink": true, "tempSelect": false, "children": [ ], } ], } ], }, "query":{ "interactive": false, "original":"drivers", "paraphrase":"drivers" }, "session":"SESSION_VALUE", "transactionId": 1, "priorTransactionId": 1 }