forked from watson-developer-cloud/swift-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(DiscoveryV1): Add retrievalDetails property to QueryResponse model
retrievalDetails uses a new type called RetrievalDetails
- Loading branch information
Anthony Oliveri
committed
Dec 11, 2018
1 parent
13a90c1
commit 631affc
Showing
3 changed files
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| /** | ||
| * Copyright IBM Corporation 2018 | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| **/ | ||
|
|
||
| import Foundation | ||
|
|
||
| /** | ||
| An object contain retrieval type information. | ||
| */ | ||
| public struct RetrievalDetails: Codable, Equatable { | ||
|
|
||
| /** | ||
| Indentifies the document retrieval strategy used for this query. `relevancy_training` indicates that the results | ||
| were returned using a relevancy trained model. `continuous_relevancy_training` indicates that the results were | ||
| returned using the continuous relevancy training model created by result feedback analysis. `untrained` means the | ||
| results were returned using the standard untrained model. | ||
| **Note**: In the event of trained collections being queried, but the trained model is not used to return results, | ||
| the **document_retrieval_strategy** will be listed as `untrained`. | ||
| */ | ||
| public enum DocumentRetrievalStrategy: String { | ||
| case untrained = "untrained" | ||
| case relevancyTraining = "relevancy_training" | ||
| case continuousRelevancyTraining = "continuous_relevancy_training" | ||
| } | ||
|
|
||
| /** | ||
| Indentifies the document retrieval strategy used for this query. `relevancy_training` indicates that the results | ||
| were returned using a relevancy trained model. `continuous_relevancy_training` indicates that the results were | ||
| returned using the continuous relevancy training model created by result feedback analysis. `untrained` means the | ||
| results were returned using the standard untrained model. | ||
| **Note**: In the event of trained collections being queried, but the trained model is not used to return results, | ||
| the **document_retrieval_strategy** will be listed as `untrained`. | ||
| */ | ||
| public var documentRetrievalStrategy: String? | ||
|
|
||
| // Map each property name to the key that shall be used for encoding/decoding. | ||
| private enum CodingKeys: String, CodingKey { | ||
| case documentRetrievalStrategy = "document_retrieval_strategy" | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters