_CoreSpotlight_FoundationModels · IOS API REFERENCE

SearchPipelineData

struct · iOS 27.0+ · SDK 27.1

struct SearchPipelineData

The type you use to store the output from a custom stage. A custom stage receives data as input and generate a `SearchPipelineData` structure as output. When generating output for a stage in your `execute` methods, build the output data and wrap it with this structure before returning it. This type manages the handoff of your output data to the next stage in the pipeline or to the model.

Members (9)

static · iOS 27.0+

scoredItems

TypeScript

static scoredItems(items: Array<ScoredSearchableItem>): SearchPipelineData

Swift declaration

static func scoredItems(_ items: [ScoredSearchableItem]) -> SearchPipelineData

Creates a pipeline data structure from the an array of scored searchable items. - Parameters: - items: The scored searchable items your stage produces.

static · iOS 27.0+

groupedItems

TypeScript

static groupedItems(groups: NativeMap<_CoreSpotlight_SearchableItemAttribute, Array<_CoreSpotlight_SearchableItem>>): SearchPipelineData

Swift declaration

static func groupedItems(_ groups: [SearchableItemAttribute : [SearchableItem]]) -> SearchPipelineData

Creates a pipeline data structure from a dictionary of attributes and searchable items. - Parameters: - items: The scored searchable items your stage produces.

static · iOS 27.0+

text

TypeScript

static text(s: string): SearchPipelineData

Swift declaration

static func text(_ s: String) -> SearchPipelineData

Creates a pipeline data structure from a text string. - Parameters: - s: The text content your stage produces.

static · iOS 27.0+

count

TypeScript

static count(n: number): SearchPipelineData

Swift declaration

static func count(_ n: Int) -> SearchPipelineData

Creates a pipeline data structure from an integer value. - Parameters: - n: The count value your stage produces.

static · iOS 27.0+

items

TypeScript

static items(items: Array<_CoreSpotlight_SearchableItem>): SearchPipelineData

Swift declaration

static func items(_ items: [SearchableItem]) -> SearchPipelineData

Creates a pipeline data structure from the an array of searchable items. - Parameters: - items: The searchable items your stage produces.

static · iOS 27.0+

table

TypeScript

static table(t: SearchResultsTable): SearchPipelineData

Swift declaration

static func table(_ t: SearchResultsTable) -> SearchPipelineData

Creates a pipeline data structure from tabular data. - Parameters: - t: The column and row data your stage produced.

init · iOS 27.0+

init

TypeScript

static init(payload: SearchPipelineData_Payload): SearchPipelineData

Swift declaration

init(payload: SearchPipelineData.Payload)

Initializes the pipeline data with the specified payload value. - Parameters: - payload: The data your custom stage produced as its output. Use the ``SearchPipelineData/Payload`` type to construct this value.

get · iOS 27.0+

payload

TypeScript

get payload(): SearchPipelineData_Payload

Swift declaration

let payload: SearchPipelineData.Payload

The output data your custom stage produced.

static · iOS 27.0+

statistic

TypeScript

static statistic(name: string, value: number): SearchPipelineData

Swift declaration

static func statistic(name: String, value: Double) -> SearchPipelineData

Creates a pipeline data structure from statistical information. - Parameters: - name: The name of the statistic your stage produced. Specify strings like “average”, “max”, “min”, “sum”, “median”, or “stddev”. - value: The statistical value you generated.

Skipped declarations

No declarations were skipped in this snapshot.

All _CoreSpotlight_FoundationModels types →