| AttributionSourceId |
Identifier for the source contributing to this attribution.
|
| BatchCreateChunksRequest |
Represents a request to batch create chunks.
|
| BatchCreateChunksResponse |
Represents the response from a batch create chunks operation.
|
| BatchDeleteChunksRequest |
Represents a request to batch delete chunks.
|
| BatchEmbedContentRequest |
Represents a batched request for embedding content.
|
| BatchEmbedContentsResponse |
Represents the response to a BatchEmbedContentRequest.
|
| BatchUpdateChunksRequest |
Represents the request body for batch updating chunks.
|
| BatchUpdateChunksResponse |
Represents the response body for batch updating chunks.
|
| Blob |
Raw media bytes.
Text should not be sent as raw bytes, use the 'text' field.
|
| CachedContent |
Content that has been preprocessed and can be used in subsequent requests to GenerativeService.
Cached content can be only used with the model it was created for.
|
| Candidate |
A response candidate generated from the model.
|
| Chunk |
A Chunk is a subpart of a Document that is treated as an independent unit for the purposes of vector representation and storage.
A Corpus can have a maximum of 1 million Chunks.
|
| ChunkData |
Extracted data that represents the Chunk content.
|
| CitationMetadata |
A collection of source attributions for a piece of content.
|
| CitationSource |
A citation to a source for a portion of a specific response.
|
| CodeExecutionResult |
Result of executing the ExecutableCode.
Only generated when using the [!:CodeExecution], and always follows a Part
containing the ExecutableCode.
|
| CodeExecutionTool |
Tool that executes code generated by the model, and automatically returns the result to the model.
See also ExecutableCode and CodeExecutionResult which are only generated when using this tool.
|
| Condition |
Filter condition applicable to a single key.
|
| Content |
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.
|
| ContentEmbedding |
Represents a list of floats that make up an embedding.
|
| Corpus |
A Corpus is a collection of Document. A project can create up to 5 corpora.
|
| CountTokensRequest |
Request to count tokens.
|
| CountTokensResponse |
Response to count tokens.
|
| CreateChunkRequest |
Represents a request to create a Chunk.
|
| CustomMetadata |
User provided metadata stored as key-value pairs.
|
| Dataset |
Dataset for training or validation.
|
| DeleteChunkRequest |
Represents a request to delete a specific chunk.
|
| Document |
A Document is a collection of Chunks. A Corpus can have a maximum of 10,000 Documents.
|
| Duration |
A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions
of seconds at nanosecond resolution.
|
| DurationJsonConverter |
JSON converter for Duration.
|
| DynamicRetrievalConfig |
Describes the options to customize dynamic retrieval.
|
| EmbedContentRequest |
Represents a request containing the content for the model to embed.
|
| EmbedContentResponse |
Represents the response to an EmbedContentRequest.
|
| ExecutableCode |
Code generated by the model that is meant to be executed, and the result returned to the model.
Only generated when using the CodeExecutionTool tool, in which the code will be automatically
executed, and a corresponding CodeExecutionResult will also be generated.
|
| FileData |
URI based data.
|
| FunctionCall |
A predicted FunctionCall returned from the model that contains a string representing
the Name with the arguments and their values.
|
| FunctionCallingConfig |
Configuration for specifying function calling behavior.
|
| FunctionDeclaration |
Declaration of a function that can be used as a Tool.
|
| FunctionResponse |
The result output from a FunctionCall that contains a string representing the
Name and a structured JSON object containing any output from
the function is used as context to the model. This should contain the result of a
FunctionCall made based on model prediction.
|
| GenerateAnswerRequest |
Request to generate an answer.
|
| GenerateAnswerResponse |
Response from the model for a grounded answer.
|
| GenerateContentRequest |
Request to generate content.
|
| GenerateContentRequestForCountToken |
Request to generate a completion from the model.
|
| GenerateContentResponse |
Response from the model supporting multiple candidate responses.
Safety ratings and content filtering are reported for both prompt in
PromptFeedback and for each candidate in FinishReason
and in SafetyRatings. The API:
- Returns either all requested candidates or none of them
- Returns no candidates at all only if there was something wrong with the prompt
(check PromptFeedback)
- Reports feedback on each candidate in FinishReason and
SafetyRatings.
|
| GenerationConfig |
Configuration options for model generation and outputs. Not all parameters are configurable
for every model.
|
| GoogleSearchRetrievalTool |
Tool to retrieve public web data for grounding, powered by Google.
|
| GoogleSearchTool |
GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.
|
| GroundingAttribution |
Attribution for a source that contributed to an answer.
|
| GroundingChunk |
Grounding chunk.
|
| GroundingMetadata |
Metadata returned to client when grounding is enabled.
|
| GroundingPassage |
Passage included inline with a grounding configuration.
|
| GroundingPassageId |
Identifier for a part within a GroundingPassage.
|
| GroundingPassages |
A repeated list of passages.
|
| GroundingSource |
The sources in which to ground the answer.
|
| GroundingSupport |
Grounding support.
|
| Hyperparameters |
Hyperparameters controlling the tuning process.
Read more at https://ai.google.dev/docs/model_tuning_guidance |
| InputFeedback |
Feedback related to the input data used to answer the question, as opposed to the
model-generated response to the question.
|
| ListCachedContentsResponse |
Response to listing cached contents.
|
| ListChunksResponse |
Response from chunks.list containing a paginated list of Chunk.
The Chunks are sorted by ascending chunk.create_time.
|
| ListCorporaResponse |
Represents a list corpora response.
|
| ListDocumentsResponse |
Response from documents.list containing a paginated list of Document.
The Documents are sorted by ascending document.create_time.
|
| ListFilesResponse |
Response to list files.
|
| ListModelsResponse |
Response to list models.
|
| ListPermissionsResponse |
Response from [!:ListPermissions] containing a paginated list of permissions.
|
| ListTunedModelsResponse |
Response from tunedModels.list containing a paginated list of Models.
|
| LogprobsCandidate |
Candidate for the logprobs token and score.
|
| LogprobsResult |
Logprobs Result.
|
| MetadataFilter |
User provided filter to limit retrieval based on Chunk or Document level metadata
values. Example (genre = drama OR genre = action):
key = "document.custom_metadata.genre"
conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}]
|
| ModalityTokenCount |
Represents token counting info for a single modality.
|
| Model |
Information about a Generative Language Model.
|
| Part |
A datatype containing media that is part of a multi-part Content message.
A Part consists of data which has an associated datatype.
A Part must have a fixed IANA MIME type identifying the type and subtype of the media
if the InlineData field is filled with raw bytes.
|
| Permission |
Permission resource grants user, group or the rest of the world access to the PaLM API resource (e.g. a tuned model, corpus).
A role is a collection of permitted operations that allows users to perform specific actions on PaLM API resources.
To make them available to users, groups, or service accounts, you assign roles.
When you assign a role, you grant permissions that the role contains.
There are three concentric roles. Each role is a superset of the previous role's permitted operations:
- reader can use the resource (TunedModel, Corpus) for inference
- writer has reader's permissions and additionally can edit and share
- owner has writer's permissions and additionally can delete
|
| PrebuiltVoiceConfig |
The configuration for the prebuilt speaker to use.
|
| PromptFeedback |
A set of the feedback metadata the prompt specified in Contents.
|
| QueryCorpusRequest |
Represents a request to query a corpus.
|
| QueryCorpusResponse |
Represents the response from querying a corpus.
|
| QueryDocumentRequest |
Request body for performing semantic search over a Document.
|
| QueryDocumentResponse |
Response from documents.query containing a list of relevant chunks.
|
| RelevantChunk |
The information for a chunk relevant to a query.
|
| RemoteFile |
A file uploaded to the API.
|
| RetrievalMetadata |
Metadata related to retrieval in the grounding flow.
|
| SafetyRating |
Safety rating for a piece of content.
The safety rating contains the category of harm and the harm probability level in that category
for a piece of content. Content is classified for safety across a number of harm categories
and the probability of the harm classification is included here.
|
| SafetySetting |
Safety setting, affecting the safety-blocking behavior.
Passing a safety setting for a category changes the allowed probability that content is blocked.
|
| Schema |
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.
|
| SearchEntryPoint |
Google search entry point.
|
| Segment |
Segment of the content.
|
| SemanticRetrieverChunk |
Identifier for a Chunk retrieved via Semantic Retriever specified in the
GenerateAnswerRequest using SemanticRetrieverConfig.
|
| SemanticRetrieverConfig |
Configuration for retrieving grounding content from a Corpus or Document
created using the Semantic Retriever API.
|
| SpeechConfig |
The speech generation config.
|
| Status |
The Status type defines a logical error model that is suitable for different
programming environments, including REST APIs and RPC APIs. It is used by
gRPC. Each Status message contains
three pieces of data: error code, error message, and error details.
You can find out more about this error model and how to work with it in the
API Design Guide.
|
| StringList |
User provided string values assigned to a single metadata key.
|
| Timestamp |
A Timestamp represents a point in time independent of any time zone or calendar,
represented as seconds and fractions of seconds at nanosecond resolution in UTC Epoch time.
|
| TimestampJsonConverter |
JSON converter for Timestamp.
|
| Tool |
Tool details that the model may use to generate response.
A Tool is a piece of code that enables the system to interact with external systems
to perform an action, or set of actions, outside of knowledge and scope of the model.
|
| ToolConfig |
The Tool configuration containing parameters for specifying Tool use in the request.
|
| TopCandidates |
Candidates with top log probabilities at each decoding step.
|
| TunedModel |
A fine-tuned model created using [!:ModelService].CreateTunedModel.
|
| TunedModelSource |
Tuned model as a source for training a new model.
|
| TuningExample |
A single example for tuning.
|
| TuningExamples |
A set of tuning examples. Can be training or validation data.
|
| TuningSnapshot |
Record for a single tuning step.
|
| TuningTask |
Tuning tasks that create tuned models.
|
| UpdateChunkRequest |
Represents a request to update a chunk.
|
| UploadFileInformation |
Represents information about a file to be uploaded.
|
| UploadFileRequest |
Represents a request to upload a local file in order to create a File resource.
|
| UploadFileResponse |
Represents the response containing details about a file uploaded through the File API.
|
| UsageMetadata |
Metadata on the generation request's token usage.
|
| VideoMetadata |
Metadata for a video File.
|
| VoiceConfig |
The configuration for the voice to use.
|
| Web |
Chunk from the web.
|