Skip to content

[Vertex AI] Rename citationSources to citations #13702

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 24, 2024
Merged

[Vertex AI] Rename citationSources to citations #13702

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fc36a9b
[Vertex AI] Rename `CitationMetadata.citationSources` to `citations`
andrewheard Sep 23, 2024
66f12ba
Fix `CitationMetadata` `Decodable` implementation
andrewheard Sep 23, 2024
8aec581
Add CHANGELOG entry
andrewheard Sep 23, 2024
8e2dc35
Merge remote-tracking branch 'origin/vertexai-release' into ah/vertex…
andrewheard Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions FirebaseVertexAI/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
- [changed] **Breaking Change**: The `unspecified` case has been removed from
the `FinishReason`, `PromptFeedback` and `HarmProbability` enums; this
scenario is now handled by the existing `unknown` case. (#13699)
- [changed] **Breaking Change**: The property `citationSources` of
`CitationMetadata` has been renamed to `citations`. (#13702)

# 11.3.0
- [added] Added `Decodable` conformance for `FunctionResponse`. (#13606)
Expand Down
8 changes: 2 additions & 6 deletions FirebaseVertexAI/Sources/GenerateContentResponse.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ public struct CandidateResponse: Sendable {
@available(iOS 15.0, macOS 11.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
public struct CitationMetadata: Sendable {
/// A list of individual cited sources and the parts of the content to which they apply.
public let citationSources: [Citation]
public let citations: [Citation]
}

/// A struct describing a source attribution.
Expand Down Expand Up @@ -290,11 +290,7 @@ extension CandidateResponse: Decodable {
}

@available(iOS 15.0, macOS 11.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
extension CitationMetadata: Decodable {
enum CodingKeys: String, CodingKey {
case citationSources = "citations"
}
}
extension CitationMetadata: Decodable {}

@available(iOS 15.0, macOS 11.0, macCatalyst 15.0, tvOS 15.0, watchOS 8.0, *)
extension Citation: Decodable {
Expand Down
10 changes: 5 additions & 5 deletions FirebaseVertexAI/Tests/Unit/GenerativeModelTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,20 +113,20 @@ final class GenerativeModelTests: XCTestCase {
XCTAssertEqual(candidate.content.parts.count, 1)
XCTAssertEqual(response.text, "Some information cited from an external source")
let citationMetadata = try XCTUnwrap(candidate.citationMetadata)
XCTAssertEqual(citationMetadata.citationSources.count, 3)
let citationSource1 = try XCTUnwrap(citationMetadata.citationSources[0])
XCTAssertEqual(citationMetadata.citations.count, 3)
let citationSource1 = try XCTUnwrap(citationMetadata.citations[0])
XCTAssertEqual(citationSource1.uri, "https://www.example.com/some-citation-1")
XCTAssertEqual(citationSource1.startIndex, 0)
XCTAssertEqual(citationSource1.endIndex, 128)
XCTAssertNil(citationSource1.title)
XCTAssertNil(citationSource1.license)
let citationSource2 = try XCTUnwrap(citationMetadata.citationSources[1])
let citationSource2 = try XCTUnwrap(citationMetadata.citations[1])
XCTAssertEqual(citationSource2.title, "some-citation-2")
XCTAssertEqual(citationSource2.startIndex, 130)
XCTAssertEqual(citationSource2.endIndex, 265)
XCTAssertNil(citationSource2.uri)
XCTAssertNil(citationSource2.license)
let citationSource3 = try XCTUnwrap(citationMetadata.citationSources[2])
let citationSource3 = try XCTUnwrap(citationMetadata.citations[2])
XCTAssertEqual(citationSource3.uri, "https://www.example.com/some-citation-3")
XCTAssertEqual(citationSource3.startIndex, 272)
XCTAssertEqual(citationSource3.endIndex, 431)
Expand Down Expand Up @@ -947,7 +947,7 @@ final class GenerativeModelTests: XCTestCase {
responses.append(content)
XCTAssertNotNil(content.text)
let candidate = try XCTUnwrap(content.candidates.first)
if let sources = candidate.citationMetadata?.citationSources {
if let sources = candidate.citationMetadata?.citations {
citations.append(contentsOf: sources)
}
}
Expand Down
Loading