You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html
+58Lines changed: 58 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -166,6 +166,7 @@ <h3>Method Details</h3>
166
166
The object takes the form of:
167
167
168
168
{ # Request message for [PredictionService.GenerateContent].
169
+
"cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
169
170
"contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
170
171
{ # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
171
172
"parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
@@ -206,6 +207,34 @@ <h3>Method Details</h3>
206
207
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
210
+
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
211
+
"default": "", # Optional. Default value of the data.
212
+
"description": "A String", # Optional. The description of the data.
213
+
"enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
214
+
"A String",
215
+
],
216
+
"example": "", # Optional. Example of the object. Will only populated when the object is the root.
217
+
"format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
218
+
"items": # Object with schema name: Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
219
+
"maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
220
+
"maxLength": "A String", # Optional. Maximum length of the Type.STRING
221
+
"maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
222
+
"maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
223
+
"minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
224
+
"minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
225
+
"minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
226
+
"minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
227
+
"nullable": True or False, # Optional. Indicates if the value may be null.
228
+
"pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
229
+
"properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
230
+
"a_key": # Object with schema name: Schema
231
+
},
232
+
"required": [ # Optional. Required properties of Type.OBJECT.
233
+
"A String",
234
+
],
235
+
"title": "A String", # Optional. The title of the Schema.
236
+
"type": "A String", # Optional. The type of the data.
{ # Request message for [PredictionService.GenerateContent].
501
+
"cachedContent": "A String", # Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
472
502
"contents": [ # Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
473
503
{ # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn.
474
504
"parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types.
@@ -509,6 +539,34 @@ <h3>Method Details</h3>
509
539
"maxOutputTokens": 42, # Optional. The maximum number of output tokens to generate per message.
"responseMimeType": "A String", # Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.
542
+
"responseSchema": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response.
543
+
"default": "", # Optional. Default value of the data.
544
+
"description": "A String", # Optional. The description of the data.
545
+
"enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
546
+
"A String",
547
+
],
548
+
"example": "", # Optional. Example of the object. Will only populated when the object is the root.
549
+
"format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc
550
+
"items": # Object with schema name: Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
551
+
"maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY.
552
+
"maxLength": "A String", # Optional. Maximum length of the Type.STRING
553
+
"maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT.
554
+
"maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER
555
+
"minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY.
556
+
"minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
557
+
"minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT.
558
+
"minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER
559
+
"nullable": True or False, # Optional. Indicates if the value may be null.
560
+
"pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
561
+
"properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
562
+
"a_key": # Object with schema name: Schema
563
+
},
564
+
"required": [ # Optional. Required properties of Type.OBJECT.
565
+
"A String",
566
+
],
567
+
"title": "A String", # Optional. The title of the Schema.
568
+
"type": "A String", # Optional. The type of the data.
Copy file name to clipboardExpand all lines: googleapiclient/discovery_cache/documents/firebaseml.v2beta.json
+9-1Lines changed: 9 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -206,7 +206,7 @@
206
206
}
207
207
}
208
208
},
209
-
"revision": "20240516",
209
+
"revision": "20240524",
210
210
"rootUrl": "https://firebaseml.googleapis.com/",
211
211
"schemas": {
212
212
"Blob": {
@@ -539,6 +539,10 @@
539
539
"description": "Request message for [PredictionService.GenerateContent].",
540
540
"id": "GenerateContentRequest",
541
541
"properties": {
542
+
"cachedContent": {
543
+
"description": "Optional. The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings. Format: `projects/{project}/locations/{location}/cachedContents/{cachedContent}`",
544
+
"type": "string"
545
+
},
542
546
"contents": {
543
547
"description": "Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.",
544
548
"items": {
@@ -627,6 +631,10 @@
627
631
"description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.",
628
632
"type": "string"
629
633
},
634
+
"responseSchema": {
635
+
"$ref": "Schema",
636
+
"description": "Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response."
0 commit comments