AI Dev Kit
Search Results for

    Show / Hide Table of Contents

    Namespace Glitch9.AIDevKit.Google

    Classes

    AttributionSourceId

    Identifier for the source contributing to this attribution.

    BatchEmbedContentsRequest

    Generates multiple embeddings from the model given input text in a synchronous call.

    BatchEmbedContentsResponse

    Response from calling {@link GenerativeModel.batchEmbedContents}.

    Blob

    Interface for sending an image.

    CachedContent

    Content that has been preprocessed and can be used in subsequent request to ModelService. Cached content can be only used with model it was created for.

    CachedContentRequest

    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. Patch request has 'updateMask' query parameter: the list of fields to update. Currently, this only supports updating customMetadata and data.

    ChunkBatchRequest<T>

    ChunkData

    Extracted data that represents the Chunk content.

    CitationMetadata

    Citation metadata that may be found on a {@link GenerateContentCandidate}.

    CitationSource

    A single citation source.

    Condition

    Filter condition applicable to a single key.

    Content

    The base structured datatype containing multi-part content of a message. It's a ChatMessage in a demonic form.

    ContentEmbedding

    A single content embedding.

    ContentFilter

    Content filtering metadata associated with processing a single request. ContentFilter contains a reason and an optional supporting string. The reason may be unspecified.

    ContentPart

    A datatype containing media that is part of a multi-part Content message.

    A ContentPart consists of data which has an associated datatype.A ContentPart can only contain one of the accepted types in ContentPart.Data.

    A ContentPart must have a fixed IANA MIME type identifying the type and subtype of the media if the InlineData field is filled with raw bytes.

    CorporaQueryRequest

    CorporaQueryResponse

    Response from corpora.query containing a list of relevant chunks.

    Corpus

    A Corpus is a collection of Documents. A project can create up to 5 corpora.

    CountTokensRequest

    Params for calling {@link GenerativeModel.countTokens}

    CountTokensResponse

    Response from calling {@link GenerativeModel.countTokens}.

    CreateChunkRequest

    Request to create a Chunk.

    CustomMetadataConverter

    CustomMetadataValue

    Dataset

    Dataset for training or validation.

    DeleteChunkRequest

    Request to delete a Chunk.

    Document

    A Document is a collection of Chunks. A Corpus can have a maximum of 10,000 Documents.

    EmbedContentRequest

    Generates an embedding from the model given an input Content.

    EmbedContentResponse

    The response to an EmbedContentRequest.

    File

    A file uploaded to the API.

    FileData

    URI based data.

    FileDataDict

    FileDataType

    FileResponse

    FluentAPIExtensions

    FunctionCallConverter

    FunctionCallingConfig

    Configuration for specifying function calling behavior.

    FunctionExtensions

    FunctionLibrary

    GenerateAnswerRequest

    Generates a response from the model given an input GenerateContentRequest. Input capabilities differ between models, including tuned models. See the model guide and tuning guide for details.

    GenerateAnswerResponse

    Response from the model for a grounded answer. If successful, the response body contains data with the following structure:

    GenerateContentRequest

    Generates a response from the model given an input GenerateContentRequest. Input capabilities differ between models, including tuned models.See the model guide and tuning guide for details.

    GenerateContentRequest.Builder

    GenerateContentResponse

    Individual response from {@link GenerativeModel.generateContent} and {@link GenerativeModel.generateContentStream}. generateContentStream() will return one in each chunk until the stream is done.

    GenerateImagesRequestConverter

    GenerateMediaConfig

    GenerateMediaRequest

    Generate image(s) from a prompt using the Imagen 3 model, or generate a video from a prompt using the Veo model. Both Imagen 3 and Veo models are only available on the google paid tier.

    GenerateMediaRequest.Builder

    GenerateTextRequest

    Generates a response from the model given an input message.

    GenerateTextResponse

    The response from the model, including candidate completions.

    GeneratedImageBlob

    GenerationConfig

    Configuration options for model generation and outputs. Not all parameters may be configurable for every model.

    GenerativeAI

    GenerativeAIClientSettingsFactory

    GenerativeAIRequest

    GenerativeAIRequest.GenerativeAIRequestBuilder<TBuilder, TRequest>

    GenerativeAISettings

    GoogleModel

    GoogleModelData

    GroundingAttribution

    Attribution for a source that contributed to an answer.

    GroundingPassage

    Passage included inline with a grounding configuration.

    GroundingPassageId

    Identifier for a part within a GroundingPassageId.

    GroundingPassages

    A repeated list of passages.

    Hyperparameters

    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}]

    ModalityConverter

    Permission

    Permission resource grants user, group or the rest of the world access to the PaLM API resource (e.g. TunedModel or 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 (e.g. tuned model, corpus) for inference

    - writer has reader's permissions and additionally can edit and share

    - owner has writer's permissions and additionally can delete

    PrebuiltVoiceConfig

    PredictionResponse

    RelevantChunk

    The information for a chunk relevant to a query.

    RequestExtensions

    ResponseExtensions

    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

    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.

    TextPrompt

    Text given to the model as a prompt. The Model will use this TextPrompt to Generate a text completion.

    Tool

    ToolConfig

    The Tool configuration containing parameters for specifying Tool use in the request.

    TransferOwnershipRequest

    Transfers ownership of the tuned model. This is the only way to change ownership of the tuned model. The current owner will be downgraded to writer role.

    TunedModel

    TunedModel.Builder

    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

    TuningTask

    UpdateChunkRequest

    Request to update a Chunk.

    UploadFileRequest

    Validator

    VideoMetadata

    Metadata for a video File.

    VoiceConfig

    Interfaces

    IChunkRequest

    Interface for all Chunk requests.

    Enums

    AnswerStyle

    AspectRatio

    FileState

    States for the lifecycle of a File.

    GranteeType

    Defines types of the grantee of this permission.

    MediaResolution

    Mode

    Defines the execution behavior for function calling by defining the execution mode.

    Operator

    Defines the valid operators that can be applied to a key-value pair.

    PaymentMode

    PersonGeneration

    State

    States for the lifecycle of a Chunk.

    TaskType

    Task type for embedding content.

    In this article
    Back to top Generated by DocFX