-
Notifications
You must be signed in to change notification settings - Fork 626
Revamp Schema declaration #6258
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.
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
Changes from 11 commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
410df27
Create schema builder file
rlazo dd97a94
Update VertexAI schema declaration to better match genAI
rlazo cc0988e
Rewrite schema declarations following the new format
rlazo c408c6b
Add missing schema test
rlazo 870a74a
Revamp function declaration using the new schema
rlazo a7a14f6
Merge branch 'main' into rl.schema.revamp
rlazo a5a3829
Add missing copyright header to SchemaTests
rlazo 9179e52
Reword refdocs for Schema
rlazo 085db3d
Fix tests after changes in StringFormat
rlazo 0ca7ff2
Reorder object arguments
rlazo 1fd27e6
Use correct tag for Schema documentation
rlazo 0bbb93f
Use null instead of StringFormat.None()
rlazo e03f1e7
Apply suggestions from code review
rlazo 4699edb
Update firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai…
rlazo fb8616b
Format fix
rlazo fbc9ebc
Adjust `obj` declaration
rlazo 438b76c
Merge branch 'main' into rl.schema.revamp
rlazo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
44 changes: 44 additions & 0 deletions
44
firebase-vertexai/src/main/kotlin/com/google/firebase/vertexai/type/FunctionDeclaration.kt
This file contains hidden or 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,44 @@ | ||
/* | ||
* Copyright 2024 Google LLC | ||
* | ||
* 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. | ||
*/ | ||
|
||
package com.google.firebase.vertexai.type | ||
|
||
/** | ||
* A declared function that a model can be given access to in order to gain info or complete tasks. | ||
* | ||
* ``` | ||
* val getExchangeRate = FunctionDeclaration( | ||
* name = "getExchangeRate", | ||
* description = "Get the exchange rate for currencies between countries.", | ||
* parameters = mapOf( | ||
* "currencyFrom" to Schema.str("The currency to convert from."), | ||
* "currencyTo" ot Schema.str("The currency to convert to.") | ||
* ) | ||
* ) | ||
* ``` | ||
* | ||
* @param name The name of the function call, this should be clear and descriptive for the model. | ||
* @param description A description of what the function does and its output. | ||
* @param parameters A list of parameters that the function accepts. | ||
* @param optionalParameters A list of parameters that can be omitted. | ||
* @see Schema | ||
*/ | ||
class FunctionDeclaration( | ||
val name: String, | ||
val description: String, | ||
val parameters: Map<String, Schema>, | ||
val optionalParameters: List<String> = emptyList(), | ||
) |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.