Skip to content

Commit 5fe65b9

Browse files
committed
[Vertex AI] Rename citationSources to citations (#13702)
1 parent 4d71da8 commit 5fe65b9

File tree

3 files changed

+9
-11
lines changed

3 files changed

+9
-11
lines changed

FirebaseVertexAI/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
is now handled by the existing `unknown` case. (#13699)
1010
- [changed] **Breaking Change**: The `data` case in the `Part` enum has been
1111
renamed to `inlineData`; no functionality changes. (#13700)
12+
- [changed] **Breaking Change**: The property `citationSources` of
13+
`CitationMetadata` has been renamed to `citations`. (#13702)
1214

1315
# 11.3.0
1416
- [added] Added `Decodable` conformance for `FunctionResponse`. (#13606)

FirebaseVertexAI/Sources/GenerateContentResponse.swift

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ public struct CandidateResponse: Sendable {
113113
@available(iOS 15.0, macOS 11.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
114114
public struct CitationMetadata: Sendable {
115115
/// A list of individual cited sources and the parts of the content to which they apply.
116-
public let citationSources: [Citation]
116+
public let citations: [Citation]
117117
}
118118

119119
/// A struct describing a source attribution.
@@ -290,11 +290,7 @@ extension CandidateResponse: Decodable {
290290
}
291291

292292
@available(iOS 15.0, macOS 11.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
293-
extension CitationMetadata: Decodable {
294-
enum CodingKeys: String, CodingKey {
295-
case citationSources = "citations"
296-
}
297-
}
293+
extension CitationMetadata: Decodable {}
298294

299295
@available(iOS 15.0, macOS 11.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
300296
extension Citation: Decodable {

FirebaseVertexAI/Tests/Unit/GenerativeModelTests.swift

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -113,20 +113,20 @@ final class GenerativeModelTests: XCTestCase {
113113
XCTAssertEqual(candidate.content.parts.count, 1)
114114
XCTAssertEqual(response.text, "Some information cited from an external source")
115115
let citationMetadata = try XCTUnwrap(candidate.citationMetadata)
116-
XCTAssertEqual(citationMetadata.citationSources.count, 3)
117-
let citationSource1 = try XCTUnwrap(citationMetadata.citationSources[0])
116+
XCTAssertEqual(citationMetadata.citations.count, 3)
117+
let citationSource1 = try XCTUnwrap(citationMetadata.citations[0])
118118
XCTAssertEqual(citationSource1.uri, "https://www.example.com/some-citation-1")
119119
XCTAssertEqual(citationSource1.startIndex, 0)
120120
XCTAssertEqual(citationSource1.endIndex, 128)
121121
XCTAssertNil(citationSource1.title)
122122
XCTAssertNil(citationSource1.license)
123-
let citationSource2 = try XCTUnwrap(citationMetadata.citationSources[1])
123+
let citationSource2 = try XCTUnwrap(citationMetadata.citations[1])
124124
XCTAssertEqual(citationSource2.title, "some-citation-2")
125125
XCTAssertEqual(citationSource2.startIndex, 130)
126126
XCTAssertEqual(citationSource2.endIndex, 265)
127127
XCTAssertNil(citationSource2.uri)
128128
XCTAssertNil(citationSource2.license)
129-
let citationSource3 = try XCTUnwrap(citationMetadata.citationSources[2])
129+
let citationSource3 = try XCTUnwrap(citationMetadata.citations[2])
130130
XCTAssertEqual(citationSource3.uri, "https://www.example.com/some-citation-3")
131131
XCTAssertEqual(citationSource3.startIndex, 272)
132132
XCTAssertEqual(citationSource3.endIndex, 431)
@@ -947,7 +947,7 @@ final class GenerativeModelTests: XCTestCase {
947947
responses.append(content)
948948
XCTAssertNotNil(content.text)
949949
let candidate = try XCTUnwrap(content.candidates.first)
950-
if let sources = candidate.citationMetadata?.citationSources {
950+
if let sources = candidate.citationMetadata?.citations {
951951
citations.append(contentsOf: sources)
952952
}
953953
}

0 commit comments

Comments
 (0)