初期画面
post
/srt/api/v1/search/initialScreen
このメソッドは、新しい検索セッションを作成し、セッションのIDを返します。 後続のすべてのリクエストでは、返されたセッションIDをセッション属性として使用して、ユーザーのアクションを実行および追跡する必要があります。
URIの例
このメソッドのURIの例は、次のとおりです:
-
http://<SEARCH_REST_API_HOST>/srt/api/v1/search/initialScreenリクエストによって新しい検索セッションが作成され、セッションIDが返されます。
リクエスト
サポートされるメディア・タイプ
- application/json
- application/xml
セッションの内容を格納するセッション・オブジェクト。
ルート・スキーマ : 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
ネストされたスキーマ : 結果
タイプ:
arraytextElementsのリスト
ソースを表示
- 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
タイプ:
arraytextElementsのリスト
ソースを表示
- 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
タイプ:
arraytextElementsのリスト
ソースを表示
- 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リソースに対するポスト・リクエストを発行することによって、検索セッションを作成し、セッションIDを返す方法を示しています。
cURLコマンド
curl -X POST "https://<SEARCH_REST_API_HOST>/srt/api/latest/search/initialScreen" -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
}