Generate vertex reference docs #8226
Merged
Conversation
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
|
hsubox76
requested review from
egilmorez,
markarndt and
kevinthecheung
as code owners
Size Report 1Affected Products
Test Logs |
Size Analysis Report 1This report is too large (1,924,681 characters) to be displayed here in a GitHub comment. Please use the below link to see the full report on Google Cloud Storage.Test Logs |
rachelsaunders
requested changes
May 7, 2024
| {% endcomment %} | ||
|
|
||
| # FunctionCall interface | ||
| A predicted \[FunctionCall\] returned from the model that contains a string representing the \[FunctionDeclaration.name\] and a structured JSON object containing the parameters and their values. |
There was a problem hiding this comment.
Do FunctionCall and FunctionDeclaration.name have the proper syntax?
They look like this in the rendered docs: https://screenshot.googleplex.com/Xz3zxfw676YwTkJ.png
| {% endcomment %} | ||
|
|
||
| # FunctionDeclaration interface | ||
| Structured representation of a function declaration as defined by the \[OpenAPI 3.0 specification\](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a Tool by the model and executed by the client. |
There was a problem hiding this comment.
Does OpenAPI 3.0 specification have the proper syntax?
It looks like this in the rendered docs: https://screenshot.googleplex.com/Aw96GRmu59HcZZB
| {% endcomment %} | ||
|
|
||
| # FunctionDeclaration interface | ||
| Structured representation of a function declaration as defined by the \[OpenAPI 3.0 specification\](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a Tool by the model and executed by the client. |
There was a problem hiding this comment.
NOT BLOCKING I think that FunctionDeclaration in the second sentence should be tagged as code.
Note that I've only marked this instance, but it seems there are lots of places throughout the source code that should be tagged as code, like FunctionDeclarationsTool, FunctionCall, ChatSession, generateContentStream(), generateContent(), etc.
There was a problem hiding this comment.
Did a pass and tried to catch as many of these as I could.
| {% endcomment %} | ||
|
|
||
| # VertexAI interface | ||
| An instance of Firebase Vertex AI. |
There was a problem hiding this comment.
Should this be?
An instance of Vertex AI for Firebase
Co-authored-by: rachelsaunders <52258509+rachelsaunders@users.noreply.github.com>
Co-authored-by: rachelsaunders <52258509+rachelsaunders@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Autogenerate VertexAI reference docs.
Our doc process is: These markdown files are checked into Github, and once that is done, a separate CL is made to copy them in to the devsite dir in google3. At that point they can be staged and are a little easier to read.
The best way to view these at the moment is probably to go to the entry point page in this branch: https://github.com/firebase/firebase-js-sdk/blob/ch-vertex-docs/docs-devsite/vertexai-preview.md