generativelanguagepb

package
v0.0.0-...-45b5d48 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 24, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "STRING",
		2: "NUMBER",
		3: "INTEGER",
		4: "BOOLEAN",
		5: "ARRAY",
		6: "OBJECT",
	}
	Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"STRING":           1,
		"NUMBER":           2,
		"INTEGER":          3,
		"BOOLEAN":          4,
		"ARRAY":            5,
		"OBJECT":           6,
	}
)

Enum value maps for Type.

View Source 
var (
	FunctionCallingConfig_Mode_name = map[int32]string{
		0: "MODE_UNSPECIFIED",
		1: "AUTO",
		2: "ANY",
		3: "NONE",
	}
	FunctionCallingConfig_Mode_value = map[string]int32{
		"MODE_UNSPECIFIED": 0,
		"AUTO":             1,
		"ANY":              2,
		"NONE":             3,
	}
)

Enum value maps for FunctionCallingConfig_Mode.

View Source 
var (
	TaskType_name = map[int32]string{
		0: "TASK_TYPE_UNSPECIFIED",
		1: "RETRIEVAL_QUERY",
		2: "RETRIEVAL_DOCUMENT",
		3: "SEMANTIC_SIMILARITY",
		4: "CLASSIFICATION",
		5: "CLUSTERING",
		6: "QUESTION_ANSWERING",
		7: "FACT_VERIFICATION",
	}
	TaskType_value = map[string]int32{
		"TASK_TYPE_UNSPECIFIED": 0,
		"RETRIEVAL_QUERY":       1,
		"RETRIEVAL_DOCUMENT":    2,
		"SEMANTIC_SIMILARITY":   3,
		"CLASSIFICATION":        4,
		"CLUSTERING":            5,
		"QUESTION_ANSWERING":    6,
		"FACT_VERIFICATION":     7,
	}
)

Enum value maps for TaskType.

View Source 
var (
	GenerateContentResponse_PromptFeedback_BlockReason_name = map[int32]string{
		0: "BLOCK_REASON_UNSPECIFIED",
		1: "SAFETY",
		2: "OTHER",
	}
	GenerateContentResponse_PromptFeedback_BlockReason_value = map[string]int32{
		"BLOCK_REASON_UNSPECIFIED": 0,
		"SAFETY":                   1,
		"OTHER":                    2,
	}
)

Enum value maps for GenerateContentResponse_PromptFeedback_BlockReason.

View Source 
var (
	Candidate_FinishReason_name = map[int32]string{
		0: "FINISH_REASON_UNSPECIFIED",
		1: "STOP",
		2: "MAX_TOKENS",
		3: "SAFETY",
		4: "RECITATION",
		5: "OTHER",
	}
	Candidate_FinishReason_value = map[string]int32{
		"FINISH_REASON_UNSPECIFIED": 0,
		"STOP":                      1,
		"MAX_TOKENS":                2,
		"SAFETY":                    3,
		"RECITATION":                4,
		"OTHER":                     5,
	}
)

Enum value maps for Candidate_FinishReason.

View Source 
var (
	GenerateAnswerRequest_AnswerStyle_name = map[int32]string{
		0: "ANSWER_STYLE_UNSPECIFIED",
		1: "ABSTRACTIVE",
		2: "EXTRACTIVE",
		3: "VERBOSE",
	}
	GenerateAnswerRequest_AnswerStyle_value = map[string]int32{
		"ANSWER_STYLE_UNSPECIFIED": 0,
		"ABSTRACTIVE":              1,
		"EXTRACTIVE":               2,
		"VERBOSE":                  3,
	}
)

Enum value maps for GenerateAnswerRequest_AnswerStyle.

View Source 
var (
	GenerateAnswerResponse_InputFeedback_BlockReason_name = map[int32]string{
		0: "BLOCK_REASON_UNSPECIFIED",
		1: "SAFETY",
		2: "OTHER",
	}
	GenerateAnswerResponse_InputFeedback_BlockReason_value = map[string]int32{
		"BLOCK_REASON_UNSPECIFIED": 0,
		"SAFETY":                   1,
		"OTHER":                    2,
	}
)

Enum value maps for GenerateAnswerResponse_InputFeedback_BlockReason.

View Source 
var (
	Permission_GranteeType_name = map[int32]string{
		0: "GRANTEE_TYPE_UNSPECIFIED",
		1: "USER",
		2: "GROUP",
		3: "EVERYONE",
	}
	Permission_GranteeType_value = map[string]int32{
		"GRANTEE_TYPE_UNSPECIFIED": 0,
		"USER":                     1,
		"GROUP":                    2,
		"EVERYONE":                 3,
	}
)

Enum value maps for Permission_GranteeType.

View Source 
var (
	Permission_Role_name = map[int32]string{
		0: "ROLE_UNSPECIFIED",
		1: "OWNER",
		2: "WRITER",
		3: "READER",
	}
	Permission_Role_value = map[string]int32{
		"ROLE_UNSPECIFIED": 0,
		"OWNER":            1,
		"WRITER":           2,
		"READER":           3,
	}
)

Enum value maps for Permission_Role.

View Source 
var (
	Condition_Operator_name = map[int32]string{
		0: "OPERATOR_UNSPECIFIED",
		1: "LESS",
		2: "LESS_EQUAL",
		3: "EQUAL",
		4: "GREATER_EQUAL",
		5: "GREATER",
		6: "NOT_EQUAL",
		7: "INCLUDES",
		8: "EXCLUDES",
	}
	Condition_Operator_value = map[string]int32{
		"OPERATOR_UNSPECIFIED": 0,
		"LESS":                 1,
		"LESS_EQUAL":           2,
		"EQUAL":                3,
		"GREATER_EQUAL":        4,
		"GREATER":              5,
		"NOT_EQUAL":            6,
		"INCLUDES":             7,
		"EXCLUDES":             8,
	}
)

Enum value maps for Condition_Operator.

View Source 
var (
	Chunk_State_name = map[int32]string{
		0:  "STATE_UNSPECIFIED",
		1:  "STATE_PENDING_PROCESSING",
		2:  "STATE_ACTIVE",
		10: "STATE_FAILED",
	}
	Chunk_State_value = map[string]int32{
		"STATE_UNSPECIFIED":        0,
		"STATE_PENDING_PROCESSING": 1,
		"STATE_ACTIVE":             2,
		"STATE_FAILED":             10,
	}
)

Enum value maps for Chunk_State.

View Source 
var (
	HarmCategory_name = map[int32]string{
		0:  "HARM_CATEGORY_UNSPECIFIED",
		1:  "HARM_CATEGORY_DEROGATORY",
		2:  "HARM_CATEGORY_TOXICITY",
		3:  "HARM_CATEGORY_VIOLENCE",
		4:  "HARM_CATEGORY_SEXUAL",
		5:  "HARM_CATEGORY_MEDICAL",
		6:  "HARM_CATEGORY_DANGEROUS",
		7:  "HARM_CATEGORY_HARASSMENT",
		8:  "HARM_CATEGORY_HATE_SPEECH",
		9:  "HARM_CATEGORY_SEXUALLY_EXPLICIT",
		10: "HARM_CATEGORY_DANGEROUS_CONTENT",
	}
	HarmCategory_value = map[string]int32{
		"HARM_CATEGORY_UNSPECIFIED":       0,
		"HARM_CATEGORY_DEROGATORY":        1,
		"HARM_CATEGORY_TOXICITY":          2,
		"HARM_CATEGORY_VIOLENCE":          3,
		"HARM_CATEGORY_SEXUAL":            4,
		"HARM_CATEGORY_MEDICAL":           5,
		"HARM_CATEGORY_DANGEROUS":         6,
		"HARM_CATEGORY_HARASSMENT":        7,
		"HARM_CATEGORY_HATE_SPEECH":       8,
		"HARM_CATEGORY_SEXUALLY_EXPLICIT": 9,
		"HARM_CATEGORY_DANGEROUS_CONTENT": 10,
	}
)

Enum value maps for HarmCategory.

View Source 
var (
	ContentFilter_BlockedReason_name = map[int32]string{
		0: "BLOCKED_REASON_UNSPECIFIED",
		1: "SAFETY",
		2: "OTHER",
	}
	ContentFilter_BlockedReason_value = map[string]int32{
		"BLOCKED_REASON_UNSPECIFIED": 0,
		"SAFETY":                     1,
		"OTHER":                      2,
	}
)

Enum value maps for ContentFilter_BlockedReason.

View Source 
var (
	SafetyRating_HarmProbability_name = map[int32]string{
		0: "HARM_PROBABILITY_UNSPECIFIED",
		1: "NEGLIGIBLE",
		2: "LOW",
		3: "MEDIUM",
		4: "HIGH",
	}
	SafetyRating_HarmProbability_value = map[string]int32{
		"HARM_PROBABILITY_UNSPECIFIED": 0,
		"NEGLIGIBLE":                   1,
		"LOW":                          2,
		"MEDIUM":                       3,
		"HIGH":                         4,
	}
)

Enum value maps for SafetyRating_HarmProbability.

View Source 
var (
	SafetySetting_HarmBlockThreshold_name = map[int32]string{
		0: "HARM_BLOCK_THRESHOLD_UNSPECIFIED",
		1: "BLOCK_LOW_AND_ABOVE",
		2: "BLOCK_MEDIUM_AND_ABOVE",
		3: "BLOCK_ONLY_HIGH",
		4: "BLOCK_NONE",
	}
	SafetySetting_HarmBlockThreshold_value = map[string]int32{
		"HARM_BLOCK_THRESHOLD_UNSPECIFIED": 0,
		"BLOCK_LOW_AND_ABOVE":              1,
		"BLOCK_MEDIUM_AND_ABOVE":           2,
		"BLOCK_ONLY_HIGH":                  3,
		"BLOCK_NONE":                       4,
	}
)

Enum value maps for SafetySetting_HarmBlockThreshold.

View Source 
var (
	TunedModel_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "CREATING",
		2: "ACTIVE",
		3: "FAILED",
	}
	TunedModel_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"CREATING":          1,
		"ACTIVE":            2,
		"FAILED":            3,
	}
)

Enum value maps for TunedModel_State.

View Source 
var File_google_ai_generativelanguage_v1beta_citation_proto protoreflect.FileDescriptor
View Source 
var File_google_ai_generativelanguage_v1beta_content_proto protoreflect.FileDescriptor
View Source 
var File_google_ai_generativelanguage_v1beta_discuss_service_proto protoreflect.FileDescriptor
View Source 
var File_google_ai_generativelanguage_v1beta_file_proto protoreflect.FileDescriptor
View Source 
var File_google_ai_generativelanguage_v1beta_file_service_proto protoreflect.FileDescriptor
View Source 
var File_google_ai_generativelanguage_v1beta_generative_service_proto protoreflect.FileDescriptor
View Source 
var File_google_ai_generativelanguage_v1beta_model_proto protoreflect.FileDescriptor
View Source 
var File_google_ai_generativelanguage_v1beta_model_service_proto protoreflect.FileDescriptor
View Source 
var File_google_ai_generativelanguage_v1beta_permission_proto protoreflect.FileDescriptor
View Source 
var File_google_ai_generativelanguage_v1beta_permission_service_proto protoreflect.FileDescriptor
View Source 
var File_google_ai_generativelanguage_v1beta_retriever_proto protoreflect.FileDescriptor
View Source 
var File_google_ai_generativelanguage_v1beta_retriever_service_proto protoreflect.FileDescriptor
View Source 
var File_google_ai_generativelanguage_v1beta_safety_proto protoreflect.FileDescriptor
View Source 
var File_google_ai_generativelanguage_v1beta_text_service_proto protoreflect.FileDescriptor
View Source 
var File_google_ai_generativelanguage_v1beta_tuned_model_proto protoreflect.FileDescriptor

Functions

func RegisterDiscussServiceServer 

func RegisterDiscussServiceServer(s *grpc.Server, srv DiscussServiceServer)

func RegisterFileServiceServer 

func RegisterFileServiceServer(s *grpc.Server, srv FileServiceServer)

func RegisterGenerativeServiceServer 

func RegisterGenerativeServiceServer(s *grpc.Server, srv GenerativeServiceServer)

func RegisterModelServiceServer 

func RegisterModelServiceServer(s *grpc.Server, srv ModelServiceServer)

func RegisterPermissionServiceServer 

func RegisterPermissionServiceServer(s *grpc.Server, srv PermissionServiceServer)

func RegisterRetrieverServiceServer 

func RegisterRetrieverServiceServer(s *grpc.Server, srv RetrieverServiceServer)

func RegisterTextServiceServer 

func RegisterTextServiceServer(s *grpc.Server, srv TextServiceServer)

Types

type AttributionSourceId 

type AttributionSourceId struct {

	// Types that are assignable to Source:
	//
	//	*AttributionSourceId_GroundingPassage
	//	*AttributionSourceId_SemanticRetrieverChunk_
	Source isAttributionSourceId_Source `protobuf_oneof:"source"`
	// contains filtered or unexported fields
}

Identifier for the source contributing to this attribution.

func (*AttributionSourceId) Descriptor deprecated 

func (*AttributionSourceId) Descriptor() ([]byte, []int)

Deprecated: Use AttributionSourceId.ProtoReflect.Descriptor instead.

func (*AttributionSourceId) GetGroundingPassage 

func (x *AttributionSourceId) GetGroundingPassage() *AttributionSourceId_GroundingPassageId

func (*AttributionSourceId) GetSemanticRetrieverChunk 

func (x *AttributionSourceId) GetSemanticRetrieverChunk() *AttributionSourceId_SemanticRetrieverChunk

func (*AttributionSourceId) GetSource 

func (m *AttributionSourceId) GetSource() isAttributionSourceId_Source

func (*AttributionSourceId) ProtoMessage 

func (*AttributionSourceId) ProtoMessage()

func (*AttributionSourceId) ProtoReflect 

func (x *AttributionSourceId) ProtoReflect() protoreflect.Message

func (*AttributionSourceId) Reset 

func (x *AttributionSourceId) Reset()

func (*AttributionSourceId) String 

func (x *AttributionSourceId) String() string

type AttributionSourceId_GroundingPassage 

type AttributionSourceId_GroundingPassage struct {
	// Identifier for an inline passage.
	GroundingPassage *AttributionSourceId_GroundingPassageId `protobuf:"bytes,1,opt,name=grounding_passage,json=groundingPassage,proto3,oneof"`
}

type AttributionSourceId_GroundingPassageId 

type AttributionSourceId_GroundingPassageId struct {

	// Output only. ID of the passage matching the `GenerateAnswerRequest`'s
	// `GroundingPassage.id`.
	PassageId string `protobuf:"bytes,1,opt,name=passage_id,json=passageId,proto3" json:"passage_id,omitempty"`
	// Output only. Index of the part within the `GenerateAnswerRequest`'s
	// `GroundingPassage.content`.
	PartIndex int32 `protobuf:"varint,2,opt,name=part_index,json=partIndex,proto3" json:"part_index,omitempty"`
	// contains filtered or unexported fields
}

Identifier for a part within a `GroundingPassage`.

func (*AttributionSourceId_GroundingPassageId) Descriptor deprecated 

func (*AttributionSourceId_GroundingPassageId) Descriptor() ([]byte, []int)

Deprecated: Use AttributionSourceId_GroundingPassageId.ProtoReflect.Descriptor instead.

func (*AttributionSourceId_GroundingPassageId) GetPartIndex 

func (x *AttributionSourceId_GroundingPassageId) GetPartIndex() int32

func (*AttributionSourceId_GroundingPassageId) GetPassageId 

func (x *AttributionSourceId_GroundingPassageId) GetPassageId() string

func (*AttributionSourceId_GroundingPassageId) ProtoMessage 

func (*AttributionSourceId_GroundingPassageId) ProtoMessage()

func (*AttributionSourceId_GroundingPassageId) ProtoReflect 

func (x *AttributionSourceId_GroundingPassageId) ProtoReflect() protoreflect.Message

func (*AttributionSourceId_GroundingPassageId) Reset 

func (x *AttributionSourceId_GroundingPassageId) Reset()

func (*AttributionSourceId_GroundingPassageId) String 

func (x *AttributionSourceId_GroundingPassageId) String() string

type AttributionSourceId_SemanticRetrieverChunk 

type AttributionSourceId_SemanticRetrieverChunk struct {

	// Output only. Name of the source matching the request's
	// `SemanticRetrieverConfig.source`. Example: `corpora/123` or
	// `corpora/123/documents/abc`
	Source string `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	// Output only. Name of the `Chunk` containing the attributed text.
	// Example: `corpora/123/documents/abc/chunks/xyz`
	Chunk string `protobuf:"bytes,2,opt,name=chunk,proto3" json:"chunk,omitempty"`
	// contains filtered or unexported fields
}

Identifier for a `Chunk` retrieved via Semantic Retriever specified in the `GenerateAnswerRequest` using `SemanticRetrieverConfig`.

func (*AttributionSourceId_SemanticRetrieverChunk) Descriptor deprecated 

func (*AttributionSourceId_SemanticRetrieverChunk) Descriptor() ([]byte, []int)

Deprecated: Use AttributionSourceId_SemanticRetrieverChunk.ProtoReflect.Descriptor instead.

func (*AttributionSourceId_SemanticRetrieverChunk) GetChunk 

func (x *AttributionSourceId_SemanticRetrieverChunk) GetChunk() string

func (*AttributionSourceId_SemanticRetrieverChunk) GetSource 

func (x *AttributionSourceId_SemanticRetrieverChunk) GetSource() string

func (*AttributionSourceId_SemanticRetrieverChunk) ProtoMessage 

func (*AttributionSourceId_SemanticRetrieverChunk) ProtoMessage()

func (*AttributionSourceId_SemanticRetrieverChunk) ProtoReflect 

func (x *AttributionSourceId_SemanticRetrieverChunk) ProtoReflect() protoreflect.Message

func (*AttributionSourceId_SemanticRetrieverChunk) Reset 

func (x *AttributionSourceId_SemanticRetrieverChunk) Reset()

func (*AttributionSourceId_SemanticRetrieverChunk) String 

func (x *AttributionSourceId_SemanticRetrieverChunk) String() string

type AttributionSourceId_SemanticRetrieverChunk_ 

type AttributionSourceId_SemanticRetrieverChunk_ struct {
	// Identifier for a `Chunk` fetched via Semantic Retriever.
	SemanticRetrieverChunk *AttributionSourceId_SemanticRetrieverChunk `protobuf:"bytes,2,opt,name=semantic_retriever_chunk,json=semanticRetrieverChunk,proto3,oneof"`
}

type BatchCreateChunksRequest 

type BatchCreateChunksRequest struct {

	// Optional. The name of the `Document` where this batch of `Chunk`s will be
	// created. The parent field in every `CreateChunkRequest` must match this
	// value. Example: `corpora/my-corpus-123/documents/the-doc-abc`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The request messages specifying the `Chunk`s to create.
	// A maximum of 100 `Chunk`s can be created in a batch.
	Requests []*CreateChunkRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

Request to batch create `Chunk`s.

func (*BatchCreateChunksRequest) Descriptor deprecated 

func (*BatchCreateChunksRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchCreateChunksRequest.ProtoReflect.Descriptor instead.

func (*BatchCreateChunksRequest) GetParent 

func (x *BatchCreateChunksRequest) GetParent() string

func (*BatchCreateChunksRequest) GetRequests 

func (x *BatchCreateChunksRequest) GetRequests() []*CreateChunkRequest

func (*BatchCreateChunksRequest) ProtoMessage 

func (*BatchCreateChunksRequest) ProtoMessage()

func (*BatchCreateChunksRequest) ProtoReflect 

func (x *BatchCreateChunksRequest) ProtoReflect() protoreflect.Message

func (*BatchCreateChunksRequest) Reset 

func (x *BatchCreateChunksRequest) Reset()

func (*BatchCreateChunksRequest) String 

func (x *BatchCreateChunksRequest) String() string

type BatchCreateChunksResponse 

type BatchCreateChunksResponse struct {

	// `Chunk`s created.
	Chunks []*Chunk `protobuf:"bytes,1,rep,name=chunks,proto3" json:"chunks,omitempty"`
	// contains filtered or unexported fields
}

Response from `BatchCreateChunks` containing a list of created `Chunk`s.

func (*BatchCreateChunksResponse) Descriptor deprecated 

func (*BatchCreateChunksResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchCreateChunksResponse.ProtoReflect.Descriptor instead.

func (*BatchCreateChunksResponse) GetChunks 

func (x *BatchCreateChunksResponse) GetChunks() []*Chunk

func (*BatchCreateChunksResponse) ProtoMessage 

func (*BatchCreateChunksResponse) ProtoMessage()

func (*BatchCreateChunksResponse) ProtoReflect 

func (x *BatchCreateChunksResponse) ProtoReflect() protoreflect.Message

func (*BatchCreateChunksResponse) Reset 

func (x *BatchCreateChunksResponse) Reset()

func (*BatchCreateChunksResponse) String 

func (x *BatchCreateChunksResponse) String() string

type BatchDeleteChunksRequest 

type BatchDeleteChunksRequest struct {

	// Optional. The name of the `Document` containing the `Chunk`s to delete.
	// The parent field in every `DeleteChunkRequest` must match this value.
	// Example: `corpora/my-corpus-123/documents/the-doc-abc`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The request messages specifying the `Chunk`s to delete.
	Requests []*DeleteChunkRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

Request to batch delete `Chunk`s.

func (*BatchDeleteChunksRequest) Descriptor deprecated 

func (*BatchDeleteChunksRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchDeleteChunksRequest.ProtoReflect.Descriptor instead.

func (*BatchDeleteChunksRequest) GetParent 

func (x *BatchDeleteChunksRequest) GetParent() string

func (*BatchDeleteChunksRequest) GetRequests 

func (x *BatchDeleteChunksRequest) GetRequests() []*DeleteChunkRequest

func (*BatchDeleteChunksRequest) ProtoMessage 

func (*BatchDeleteChunksRequest) ProtoMessage()

func (*BatchDeleteChunksRequest) ProtoReflect 

func (x *BatchDeleteChunksRequest) ProtoReflect() protoreflect.Message

func (*BatchDeleteChunksRequest) Reset 

func (x *BatchDeleteChunksRequest) Reset()

func (*BatchDeleteChunksRequest) String 

func (x *BatchDeleteChunksRequest) String() string

type BatchEmbedContentsRequest 

type BatchEmbedContentsRequest struct {

	// Required. The model's resource name. This serves as an ID for the Model to
	// use.
	//
	// This name should match a model name returned by the `ListModels` method.
	//
	// Format: `models/{model}`
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Required. Embed requests for the batch. The model in each of these requests
	// must match the model specified `BatchEmbedContentsRequest.model`.
	Requests []*EmbedContentRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

Batch request to get embeddings from the model for a list of prompts.

func (*BatchEmbedContentsRequest) Descriptor deprecated 

func (*BatchEmbedContentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchEmbedContentsRequest.ProtoReflect.Descriptor instead.

func (*BatchEmbedContentsRequest) GetModel 

func (x *BatchEmbedContentsRequest) GetModel() string

func (*BatchEmbedContentsRequest) GetRequests 

func (x *BatchEmbedContentsRequest) GetRequests() []*EmbedContentRequest

func (*BatchEmbedContentsRequest) ProtoMessage 

func (*BatchEmbedContentsRequest) ProtoMessage()

func (*BatchEmbedContentsRequest) ProtoReflect 

func (x *BatchEmbedContentsRequest) ProtoReflect() protoreflect.Message

func (*BatchEmbedContentsRequest) Reset 

func (x *BatchEmbedContentsRequest) Reset()

func (*BatchEmbedContentsRequest) String 

func (x *BatchEmbedContentsRequest) String() string

type BatchEmbedContentsResponse 

type BatchEmbedContentsResponse struct {

	// Output only. The embeddings for each request, in the same order as provided
	// in the batch request.
	Embeddings []*ContentEmbedding `protobuf:"bytes,1,rep,name=embeddings,proto3" json:"embeddings,omitempty"`
	// contains filtered or unexported fields
}

The response to a `BatchEmbedContentsRequest`.

func (*BatchEmbedContentsResponse) Descriptor deprecated 

func (*BatchEmbedContentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchEmbedContentsResponse.ProtoReflect.Descriptor instead.

func (*BatchEmbedContentsResponse) GetEmbeddings 

func (x *BatchEmbedContentsResponse) GetEmbeddings() []*ContentEmbedding

func (*BatchEmbedContentsResponse) ProtoMessage 

func (*BatchEmbedContentsResponse) ProtoMessage()

func (*BatchEmbedContentsResponse) ProtoReflect 

func (x *BatchEmbedContentsResponse) ProtoReflect() protoreflect.Message

func (*BatchEmbedContentsResponse) Reset 

func (x *BatchEmbedContentsResponse) Reset()

func (*BatchEmbedContentsResponse) String 

func (x *BatchEmbedContentsResponse) String() string

type BatchEmbedTextRequest 

type BatchEmbedTextRequest struct {

	// Required. The name of the `Model` to use for generating the embedding.
	// Examples:
	//
	//	models/embedding-gecko-001
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Optional. The free-form input texts that the model will turn into an
	// embedding. The current limit is 100 texts, over which an error will be
	// thrown.
	Texts []string `protobuf:"bytes,2,rep,name=texts,proto3" json:"texts,omitempty"`
	// Optional. Embed requests for the batch. Only one of `texts` or `requests`
	// can be set.
	Requests []*EmbedTextRequest `protobuf:"bytes,3,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

Batch request to get a text embedding from the model.

func (*BatchEmbedTextRequest) Descriptor deprecated 

func (*BatchEmbedTextRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchEmbedTextRequest.ProtoReflect.Descriptor instead.

func (*BatchEmbedTextRequest) GetModel 

func (x *BatchEmbedTextRequest) GetModel() string

func (*BatchEmbedTextRequest) GetRequests 

func (x *BatchEmbedTextRequest) GetRequests() []*EmbedTextRequest

func (*BatchEmbedTextRequest) GetTexts 

func (x *BatchEmbedTextRequest) GetTexts() []string

func (*BatchEmbedTextRequest) ProtoMessage 

func (*BatchEmbedTextRequest) ProtoMessage()

func (*BatchEmbedTextRequest) ProtoReflect 

func (x *BatchEmbedTextRequest) ProtoReflect() protoreflect.Message

func (*BatchEmbedTextRequest) Reset 

func (x *BatchEmbedTextRequest) Reset()

func (*BatchEmbedTextRequest) String 

func (x *BatchEmbedTextRequest) String() string

type BatchEmbedTextResponse 

type BatchEmbedTextResponse struct {

	// Output only. The embeddings generated from the input text.
	Embeddings []*Embedding `protobuf:"bytes,1,rep,name=embeddings,proto3" json:"embeddings,omitempty"`
	// contains filtered or unexported fields
}

The response to a EmbedTextRequest.

func (*BatchEmbedTextResponse) Descriptor deprecated 

func (*BatchEmbedTextResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchEmbedTextResponse.ProtoReflect.Descriptor instead.

func (*BatchEmbedTextResponse) GetEmbeddings 

func (x *BatchEmbedTextResponse) GetEmbeddings() []*Embedding

func (*BatchEmbedTextResponse) ProtoMessage 

func (*BatchEmbedTextResponse) ProtoMessage()

func (*BatchEmbedTextResponse) ProtoReflect 

func (x *BatchEmbedTextResponse) ProtoReflect() protoreflect.Message

func (*BatchEmbedTextResponse) Reset 

func (x *BatchEmbedTextResponse) Reset()

func (*BatchEmbedTextResponse) String 

func (x *BatchEmbedTextResponse) String() string

type BatchUpdateChunksRequest 

type BatchUpdateChunksRequest struct {

	// Optional. The name of the `Document` containing the `Chunk`s to update.
	// The parent field in every `UpdateChunkRequest` must match this value.
	// Example: `corpora/my-corpus-123/documents/the-doc-abc`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The request messages specifying the `Chunk`s to update.
	// A maximum of 100 `Chunk`s can be updated in a batch.
	Requests []*UpdateChunkRequest `protobuf:"bytes,2,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

Request to batch update `Chunk`s.

func (*BatchUpdateChunksRequest) Descriptor deprecated 

func (*BatchUpdateChunksRequest) Descriptor() ([]byte, []int)

Deprecated: Use BatchUpdateChunksRequest.ProtoReflect.Descriptor instead.

func (*BatchUpdateChunksRequest) GetParent 

func (x *BatchUpdateChunksRequest) GetParent() string

func (*BatchUpdateChunksRequest) GetRequests 

func (x *BatchUpdateChunksRequest) GetRequests() []*UpdateChunkRequest

func (*BatchUpdateChunksRequest) ProtoMessage 

func (*BatchUpdateChunksRequest) ProtoMessage()

func (*BatchUpdateChunksRequest) ProtoReflect 

func (x *BatchUpdateChunksRequest) ProtoReflect() protoreflect.Message

func (*BatchUpdateChunksRequest) Reset 

func (x *BatchUpdateChunksRequest) Reset()

func (*BatchUpdateChunksRequest) String 

func (x *BatchUpdateChunksRequest) String() string

type BatchUpdateChunksResponse 

type BatchUpdateChunksResponse struct {

	// `Chunk`s updated.
	Chunks []*Chunk `protobuf:"bytes,1,rep,name=chunks,proto3" json:"chunks,omitempty"`
	// contains filtered or unexported fields
}

Response from `BatchUpdateChunks` containing a list of updated `Chunk`s.

func (*BatchUpdateChunksResponse) Descriptor deprecated 

func (*BatchUpdateChunksResponse) Descriptor() ([]byte, []int)

Deprecated: Use BatchUpdateChunksResponse.ProtoReflect.Descriptor instead.

func (*BatchUpdateChunksResponse) GetChunks 

func (x *BatchUpdateChunksResponse) GetChunks() []*Chunk

func (*BatchUpdateChunksResponse) ProtoMessage 

func (*BatchUpdateChunksResponse) ProtoMessage()

func (*BatchUpdateChunksResponse) ProtoReflect 

func (x *BatchUpdateChunksResponse) ProtoReflect() protoreflect.Message

func (*BatchUpdateChunksResponse) Reset 

func (x *BatchUpdateChunksResponse) Reset()

func (*BatchUpdateChunksResponse) String 

func (x *BatchUpdateChunksResponse) String() string

type Blob 

type Blob struct {

	// The IANA standard MIME type of the source data.
	// Accepted types include: "image/png", "image/jpeg", "image/heic",
	// "image/heif", "image/webp".
	MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Raw bytes for media formats.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Raw media bytes.

Text should not be sent as raw bytes, use the 'text' field.

func (*Blob) Descriptor deprecated 

func (*Blob) Descriptor() ([]byte, []int)

Deprecated: Use Blob.ProtoReflect.Descriptor instead.

func (*Blob) GetData 

func (x *Blob) GetData() []byte

func (*Blob) GetMimeType 

func (x *Blob) GetMimeType() string

func (*Blob) ProtoMessage 

func (*Blob) ProtoMessage()

func (*Blob) ProtoReflect 

func (x *Blob) ProtoReflect() protoreflect.Message

func (*Blob) Reset 

func (x *Blob) Reset()

func (*Blob) String 

func (x *Blob) String() string

type Candidate 

type Candidate struct {

	// Output only. Index of the candidate in the list of candidates.
	Index *int32 `protobuf:"varint,3,opt,name=index,proto3,oneof" json:"index,omitempty"`
	// Output only. Generated content returned from the model.
	Content *Content `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// Optional. Output only. The reason why the model stopped generating tokens.
	//
	// If empty, the model has not stopped generating the tokens.
	FinishReason Candidate_FinishReason `` /* 162-byte string literal not displayed */
	// List of ratings for the safety of a response candidate.
	//
	// There is at most one rating per category.
	SafetyRatings []*SafetyRating `protobuf:"bytes,5,rep,name=safety_ratings,json=safetyRatings,proto3" json:"safety_ratings,omitempty"`
	// Output only. Citation information for model-generated candidate.
	//
	// This field may be populated with recitation information for any text
	// included in the `content`. These are passages that are "recited" from
	// copyrighted material in the foundational LLM's training data.
	CitationMetadata *CitationMetadata `protobuf:"bytes,6,opt,name=citation_metadata,json=citationMetadata,proto3" json:"citation_metadata,omitempty"`
	// Output only. Token count for this candidate.
	TokenCount int32 `protobuf:"varint,7,opt,name=token_count,json=tokenCount,proto3" json:"token_count,omitempty"`
	// Output only. Attribution information for sources that contributed to a
	// grounded answer.
	//
	// This field is populated for `GenerateAnswer` calls.
	GroundingAttributions []*GroundingAttribution `protobuf:"bytes,8,rep,name=grounding_attributions,json=groundingAttributions,proto3" json:"grounding_attributions,omitempty"`
	// contains filtered or unexported fields
}

A response candidate generated from the model.

func (*Candidate) Descriptor deprecated 

func (*Candidate) Descriptor() ([]byte, []int)

Deprecated: Use Candidate.ProtoReflect.Descriptor instead.

func (*Candidate) GetCitationMetadata 

func (x *Candidate) GetCitationMetadata() *CitationMetadata

func (*Candidate) GetContent 

func (x *Candidate) GetContent() *Content

func (*Candidate) GetFinishReason 

func (x *Candidate) GetFinishReason() Candidate_FinishReason

func (*Candidate) GetGroundingAttributions 

func (x *Candidate) GetGroundingAttributions() []*GroundingAttribution

func (*Candidate) GetIndex 

func (x *Candidate) GetIndex() int32

func (*Candidate) GetSafetyRatings 

func (x *Candidate) GetSafetyRatings() []*SafetyRating

func (*Candidate) GetTokenCount 

func (x *Candidate) GetTokenCount() int32

func (*Candidate) ProtoMessage 

func (*Candidate) ProtoMessage()

func (*Candidate) ProtoReflect 

func (x *Candidate) ProtoReflect() protoreflect.Message

func (*Candidate) Reset 

func (x *Candidate) Reset()

func (*Candidate) String 

func (x *Candidate) String() string

type Candidate_FinishReason 

type Candidate_FinishReason int32

Defines the reason why the model stopped generating tokens. 

const (
	// Default value. This value is unused.
	Candidate_FINISH_REASON_UNSPECIFIED Candidate_FinishReason = 0
	// Natural stop point of the model or provided stop sequence.
	Candidate_STOP Candidate_FinishReason = 1
	// The maximum number of tokens as specified in the request was reached.
	Candidate_MAX_TOKENS Candidate_FinishReason = 2
	// The candidate content was flagged for safety reasons.
	Candidate_SAFETY Candidate_FinishReason = 3
	// The candidate content was flagged for recitation reasons.
	Candidate_RECITATION Candidate_FinishReason = 4
	// Unknown reason.
	Candidate_OTHER Candidate_FinishReason = 5
)

func (Candidate_FinishReason) Descriptor 

func (Candidate_FinishReason) Descriptor() protoreflect.EnumDescriptor

func (Candidate_FinishReason) Enum 

func (x Candidate_FinishReason) Enum() *Candidate_FinishReason

func (Candidate_FinishReason) EnumDescriptor deprecated 

func (Candidate_FinishReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use Candidate_FinishReason.Descriptor instead.

func (Candidate_FinishReason) Number 

func (x Candidate_FinishReason) Number() protoreflect.EnumNumber

func (Candidate_FinishReason) String 

func (x Candidate_FinishReason) String() string

func (Candidate_FinishReason) Type 

func (Candidate_FinishReason) Type() protoreflect.EnumType

type Chunk 

type Chunk struct {

	// Immutable. Identifier. The `Chunk` resource name. The ID (name excluding
	// the "corpora/*/documents/*/chunks/" prefix) can contain up to 40 characters
	// that are lowercase alphanumeric or dashes (-). The ID cannot start or end
	// with a dash. If the name is empty on create, a random 12-character unique
	// ID will be generated.
	// Example: `corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The content for the `Chunk`, such as the text string.
	// The maximum number of tokens per chunk is 2043.
	Data *ChunkData `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// Optional. User provided custom metadata stored as key-value pairs.
	// The maximum number of `CustomMetadata` per chunk is 20.
	CustomMetadata []*CustomMetadata `protobuf:"bytes,3,rep,name=custom_metadata,json=customMetadata,proto3" json:"custom_metadata,omitempty"`
	// Output only. The Timestamp of when the `Chunk` was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The Timestamp of when the `Chunk` was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Current state of the `Chunk`.
	State Chunk_State `protobuf:"varint,6,opt,name=state,proto3,enum=google.ai.generativelanguage.v1beta.Chunk_State" json:"state,omitempty"`
	// contains filtered or unexported fields
}

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 `Chunk`s.

func (*Chunk) Descriptor deprecated 

func (*Chunk) Descriptor() ([]byte, []int)

Deprecated: Use Chunk.ProtoReflect.Descriptor instead.

func (*Chunk) GetCreateTime 

func (x *Chunk) GetCreateTime() *timestamppb.Timestamp

func (*Chunk) GetCustomMetadata 

func (x *Chunk) GetCustomMetadata() []*CustomMetadata

func (*Chunk) GetData 

func (x *Chunk) GetData() *ChunkData

func (*Chunk) GetName 

func (x *Chunk) GetName() string

func (*Chunk) GetState 

func (x *Chunk) GetState() Chunk_State

func (*Chunk) GetUpdateTime 

func (x *Chunk) GetUpdateTime() *timestamppb.Timestamp

func (*Chunk) ProtoMessage 

func (*Chunk) ProtoMessage()

func (*Chunk) ProtoReflect 

func (x *Chunk) ProtoReflect() protoreflect.Message

func (*Chunk) Reset 

func (x *Chunk) Reset()

func (*Chunk) String 

func (x *Chunk) String() string

type ChunkData 

type ChunkData struct {

	// Types that are assignable to Data:
	//
	//	*ChunkData_StringValue
	Data isChunkData_Data `protobuf_oneof:"data"`
	// contains filtered or unexported fields
}

Extracted data that represents the `Chunk` content.

func (*ChunkData) Descriptor deprecated 

func (*ChunkData) Descriptor() ([]byte, []int)

Deprecated: Use ChunkData.ProtoReflect.Descriptor instead.

func (*ChunkData) GetData 

func (m *ChunkData) GetData() isChunkData_Data

func (*ChunkData) GetStringValue 

func (x *ChunkData) GetStringValue() string

func (*ChunkData) ProtoMessage 

func (*ChunkData) ProtoMessage()

func (*ChunkData) ProtoReflect 

func (x *ChunkData) ProtoReflect() protoreflect.Message

func (*ChunkData) Reset 

func (x *ChunkData) Reset()

func (*ChunkData) String 

func (x *ChunkData) String() string

type ChunkData_StringValue 

type ChunkData_StringValue struct {
	// The `Chunk` content as a string.
	// The maximum number of tokens per chunk is 2043.
	StringValue string `protobuf:"bytes,1,opt,name=string_value,json=stringValue,proto3,oneof"`
}

type Chunk_State 

type Chunk_State int32

States for the lifecycle of a `Chunk`. 

const (
	// The default value. This value is used if the state is omitted.
	Chunk_STATE_UNSPECIFIED Chunk_State = 0
	// `Chunk` is being processed (embedding and vector storage).
	Chunk_STATE_PENDING_PROCESSING Chunk_State = 1
	// `Chunk` is processed and available for querying.
	Chunk_STATE_ACTIVE Chunk_State = 2
	// `Chunk` failed processing.
	Chunk_STATE_FAILED Chunk_State = 10
)

func (Chunk_State) Descriptor 

func (Chunk_State) Descriptor() protoreflect.EnumDescriptor

func (Chunk_State) Enum 

func (x Chunk_State) Enum() *Chunk_State

func (Chunk_State) EnumDescriptor deprecated 

func (Chunk_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Chunk_State.Descriptor instead.

func (Chunk_State) Number 

func (x Chunk_State) Number() protoreflect.EnumNumber

func (Chunk_State) String 

func (x Chunk_State) String() string

func (Chunk_State) Type 

func (Chunk_State) Type() protoreflect.EnumType

type CitationMetadata 

type CitationMetadata struct {

	// Citations to sources for a specific response.
	CitationSources []*CitationSource `protobuf:"bytes,1,rep,name=citation_sources,json=citationSources,proto3" json:"citation_sources,omitempty"`
	// contains filtered or unexported fields
}

A collection of source attributions for a piece of content.

func (*CitationMetadata) Descriptor deprecated 

func (*CitationMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CitationMetadata.ProtoReflect.Descriptor instead.

func (*CitationMetadata) GetCitationSources 

func (x *CitationMetadata) GetCitationSources() []*CitationSource

func (*CitationMetadata) ProtoMessage 

func (*CitationMetadata) ProtoMessage()

func (*CitationMetadata) ProtoReflect 

func (x *CitationMetadata) ProtoReflect() protoreflect.Message

func (*CitationMetadata) Reset 

func (x *CitationMetadata) Reset()

func (*CitationMetadata) String 

func (x *CitationMetadata) String() string

type CitationSource 

type CitationSource struct {

	// Optional. Start of segment of the response that is attributed to this
	// source.
	//
	// Index indicates the start of the segment, measured in bytes.
	StartIndex *int32 `protobuf:"varint,1,opt,name=start_index,json=startIndex,proto3,oneof" json:"start_index,omitempty"`
	// Optional. End of the attributed segment, exclusive.
	EndIndex *int32 `protobuf:"varint,2,opt,name=end_index,json=endIndex,proto3,oneof" json:"end_index,omitempty"`
	// Optional. URI that is attributed as a source for a portion of the text.
	Uri *string `protobuf:"bytes,3,opt,name=uri,proto3,oneof" json:"uri,omitempty"`
	// Optional. License for the GitHub project that is attributed as a source for
	// segment.
	//
	// License info is required for code citations.
	License *string `protobuf:"bytes,4,opt,name=license,proto3,oneof" json:"license,omitempty"`
	// contains filtered or unexported fields
}

A citation to a source for a portion of a specific response.

func (*CitationSource) Descriptor deprecated 

func (*CitationSource) Descriptor() ([]byte, []int)

Deprecated: Use CitationSource.ProtoReflect.Descriptor instead.

func (*CitationSource) GetEndIndex 

func (x *CitationSource) GetEndIndex() int32

func (*CitationSource) GetLicense 

func (x *CitationSource) GetLicense() string

func (*CitationSource) GetStartIndex 

func (x *CitationSource) GetStartIndex() int32

func (*CitationSource) GetUri 

func (x *CitationSource) GetUri() string

func (*CitationSource) ProtoMessage 

func (*CitationSource) ProtoMessage()

func (*CitationSource) ProtoReflect 

func (x *CitationSource) ProtoReflect() protoreflect.Message

func (*CitationSource) Reset 

func (x *CitationSource) Reset()

func (*CitationSource) String 

func (x *CitationSource) String() string

type Condition 

type Condition struct {

	// The value type must be consistent with the value type defined in the field
	// for the corresponding key. If the value types are not consistent, the
	// result will be an empty set. When the `CustomMetadata` has a `StringList`
	// value type, the filtering condition should use `string_value` paired with
	// an INCLUDES/EXCLUDES operation, otherwise the result will also be an empty
	// set.
	//
	// Types that are assignable to Value:
	//
	//	*Condition_StringValue
	//	*Condition_NumericValue
	Value isCondition_Value `protobuf_oneof:"value"`
	// Required. Operator applied to the given key-value pair to trigger the
	// condition.
	Operation Condition_Operator `` /* 132-byte string literal not displayed */
	// contains filtered or unexported fields
}

Filter condition applicable to a single key.

func (*Condition) Descriptor deprecated 

func (*Condition) Descriptor() ([]byte, []int)

Deprecated: Use Condition.ProtoReflect.Descriptor instead.

func (*Condition) GetNumericValue 

func (x *Condition) GetNumericValue() float32

func (*Condition) GetOperation 

func (x *Condition) GetOperation() Condition_Operator

func (*Condition) GetStringValue 

func (x *Condition) GetStringValue() string

func (*Condition) GetValue 

func (m *Condition) GetValue() isCondition_Value

func (*Condition) ProtoMessage 

func (*Condition) ProtoMessage()

func (*Condition) ProtoReflect 

func (x *Condition) ProtoReflect() protoreflect.Message

func (*Condition) Reset 

func (x *Condition) Reset()

func (*Condition) String 

func (x *Condition) String() string

type Condition_NumericValue 

type Condition_NumericValue struct {
	// The numeric value to filter the metadata on.
	NumericValue float32 `protobuf:"fixed32,6,opt,name=numeric_value,json=numericValue,proto3,oneof"`
}

type Condition_Operator 

type Condition_Operator int32

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

const (
	// The default value. This value is unused.
	Condition_OPERATOR_UNSPECIFIED Condition_Operator = 0
	// Supported by numeric.
	Condition_LESS Condition_Operator = 1
	// Supported by numeric.
	Condition_LESS_EQUAL Condition_Operator = 2
	// Supported by numeric & string.
	Condition_EQUAL Condition_Operator = 3
	// Supported by numeric.
	Condition_GREATER_EQUAL Condition_Operator = 4
	// Supported by numeric.
	Condition_GREATER Condition_Operator = 5
	// Supported by numeric & string.
	Condition_NOT_EQUAL Condition_Operator = 6
	// Supported by string only when `CustomMetadata` value type for the given
	// key has a `string_list_value`.
	Condition_INCLUDES Condition_Operator = 7
	// Supported by string only when `CustomMetadata` value type for the given
	// key has a `string_list_value`.
	Condition_EXCLUDES Condition_Operator = 8
)

func (Condition_Operator) Descriptor 

func (Condition_Operator) Descriptor() protoreflect.EnumDescriptor

func (Condition_Operator) Enum 

func (x Condition_Operator) Enum() *Condition_Operator

func (Condition_Operator) EnumDescriptor deprecated 

func (Condition_Operator) EnumDescriptor() ([]byte, []int)

Deprecated: Use Condition_Operator.Descriptor instead.

func (Condition_Operator) Number 

func (x Condition_Operator) Number() protoreflect.EnumNumber

func (Condition_Operator) String 

func (x Condition_Operator) String() string

func (Condition_Operator) Type 

func (Condition_Operator) Type() protoreflect.EnumType

type Condition_StringValue 

type Condition_StringValue struct {
	// The string value to filter the metadata on.
	StringValue string `protobuf:"bytes,1,opt,name=string_value,json=stringValue,proto3,oneof"`
}

type Content 

type Content struct {

	// Ordered `Parts` that constitute a single message. Parts may have different
	// MIME types.
	Parts []*Part `protobuf:"bytes,1,rep,name=parts,proto3" json:"parts,omitempty"`
	// Optional. The producer of the content. Must be either 'user' or 'model'.
	//
	// Useful to set for multi-turn conversations, otherwise can be left blank
	// or unset.
	Role string `protobuf:"bytes,2,opt,name=role,proto3" json:"role,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*Content) Descriptor deprecated 

func (*Content) Descriptor() ([]byte, []int)

Deprecated: Use Content.ProtoReflect.Descriptor instead.

func (*Content) GetParts 

func (x *Content) GetParts() []*Part

func (*Content) GetRole 

func (x *Content) GetRole() string

func (*Content) ProtoMessage 

func (*Content) ProtoMessage()

func (*Content) ProtoReflect 

func (x *Content) ProtoReflect() protoreflect.Message

func (*Content) Reset 

func (x *Content) Reset()

func (*Content) String 

func (x *Content) String() string

type ContentEmbedding 

type ContentEmbedding struct {

	// The embedding values.
	Values []float32 `protobuf:"fixed32,1,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

A list of floats representing an embedding.

func (*ContentEmbedding) Descriptor deprecated 

func (*ContentEmbedding) Descriptor() ([]byte, []int)

Deprecated: Use ContentEmbedding.ProtoReflect.Descriptor instead.

func (*ContentEmbedding) GetValues 

func (x *ContentEmbedding) GetValues() []float32

func (*ContentEmbedding) ProtoMessage 

func (*ContentEmbedding) ProtoMessage()

func (*ContentEmbedding) ProtoReflect 

func (x *ContentEmbedding) ProtoReflect() protoreflect.Message

func (*ContentEmbedding) Reset 

func (x *ContentEmbedding) Reset()

func (*ContentEmbedding) String 

func (x *ContentEmbedding) String() string

type ContentFilter 

type ContentFilter struct {

	// The reason content was blocked during request processing.
	Reason ContentFilter_BlockedReason `` /* 135-byte string literal not displayed */
	// A string that describes the filtering behavior in more detail.
	Message *string `protobuf:"bytes,2,opt,name=message,proto3,oneof" json:"message,omitempty"`
	// contains filtered or unexported fields
}

Content filtering metadata associated with processing a single request.

ContentFilter contains a reason and an optional supporting string. The reason may be unspecified.

func (*ContentFilter) Descriptor deprecated 

func (*ContentFilter) Descriptor() ([]byte, []int)

Deprecated: Use ContentFilter.ProtoReflect.Descriptor instead.

func (*ContentFilter) GetMessage 

func (x *ContentFilter) GetMessage() string

func (*ContentFilter) GetReason 

func (x *ContentFilter) GetReason() ContentFilter_BlockedReason

func (*ContentFilter) ProtoMessage 

func (*ContentFilter) ProtoMessage()

func (*ContentFilter) ProtoReflect 

func (x *ContentFilter) ProtoReflect() protoreflect.Message

func (*ContentFilter) Reset 

func (x *ContentFilter) Reset()

func (*ContentFilter) String 

func (x *ContentFilter) String() string

type ContentFilter_BlockedReason 

type ContentFilter_BlockedReason int32

A list of reasons why content may have been blocked. 

const (
	// A blocked reason was not specified.
	ContentFilter_BLOCKED_REASON_UNSPECIFIED ContentFilter_BlockedReason = 0
	// Content was blocked by safety settings.
	ContentFilter_SAFETY ContentFilter_BlockedReason = 1
	// Content was blocked, but the reason is uncategorized.
	ContentFilter_OTHER ContentFilter_BlockedReason = 2
)

func (ContentFilter_BlockedReason) Descriptor 

func (ContentFilter_BlockedReason) Descriptor() protoreflect.EnumDescriptor

func (ContentFilter_BlockedReason) Enum 

func (x ContentFilter_BlockedReason) Enum() *ContentFilter_BlockedReason

func (ContentFilter_BlockedReason) EnumDescriptor deprecated 

func (ContentFilter_BlockedReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use ContentFilter_BlockedReason.Descriptor instead.

func (ContentFilter_BlockedReason) Number 

func (x ContentFilter_BlockedReason) Number() protoreflect.EnumNumber

func (ContentFilter_BlockedReason) String 

func (x ContentFilter_BlockedReason) String() string

func (ContentFilter_BlockedReason) Type 

func (ContentFilter_BlockedReason) Type() protoreflect.EnumType

type Corpus 

type Corpus struct {

	// Immutable. Identifier. The `Corpus` resource name. The ID (name excluding
	// the "corpora/" prefix) can contain up to 40 characters that are lowercase
	// alphanumeric or dashes
	// (-). The ID cannot start or end with a dash. If the name is empty on
	// create, a unique name will be derived from `display_name` along with a 12
	// character random suffix.
	// Example: `corpora/my-awesome-corpora-123a456b789c`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The human-readable display name for the `Corpus`. The display
	// name must be no more than 512 characters in length, including spaces.
	// Example: "Docs on Semantic Retriever"
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. The Timestamp of when the `Corpus` was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The Timestamp of when the `Corpus` was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

A `Corpus` is a collection of `Document`s. A project can create up to 5 corpora.

func (*Corpus) Descriptor deprecated 

func (*Corpus) Descriptor() ([]byte, []int)

Deprecated: Use Corpus.ProtoReflect.Descriptor instead.

func (*Corpus) GetCreateTime 

func (x *Corpus) GetCreateTime() *timestamppb.Timestamp

func (*Corpus) GetDisplayName 

func (x *Corpus) GetDisplayName() string

func (*Corpus) GetName 

func (x *Corpus) GetName() string

func (*Corpus) GetUpdateTime 

func (x *Corpus) GetUpdateTime() *timestamppb.Timestamp

func (*Corpus) ProtoMessage 

func (*Corpus) ProtoMessage()

func (*Corpus) ProtoReflect 

func (x *Corpus) ProtoReflect() protoreflect.Message

func (*Corpus) Reset 

func (x *Corpus) Reset()

func (*Corpus) String 

func (x *Corpus) String() string

type CountMessageTokensRequest 

type CountMessageTokensRequest struct {

	// Required. The model's resource name. This serves as an ID for the Model to
	// use.
	//
	// This name should match a model name returned by the `ListModels` method.
	//
	// Format: `models/{model}`
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Required. The prompt, whose token count is to be returned.
	Prompt *MessagePrompt `protobuf:"bytes,2,opt,name=prompt,proto3" json:"prompt,omitempty"`
	// contains filtered or unexported fields
}

Counts the number of tokens in the `prompt` sent to a model.

Models may tokenize text differently, so each model may return a different `token_count`.

func (*CountMessageTokensRequest) Descriptor deprecated 

func (*CountMessageTokensRequest) Descriptor() ([]byte, []int)

Deprecated: Use CountMessageTokensRequest.ProtoReflect.Descriptor instead.

func (*CountMessageTokensRequest) GetModel 

func (x *CountMessageTokensRequest) GetModel() string

func (*CountMessageTokensRequest) GetPrompt 

func (x *CountMessageTokensRequest) GetPrompt() *MessagePrompt

func (*CountMessageTokensRequest) ProtoMessage 

func (*CountMessageTokensRequest) ProtoMessage()

func (*CountMessageTokensRequest) ProtoReflect 

func (x *CountMessageTokensRequest) ProtoReflect() protoreflect.Message

func (*CountMessageTokensRequest) Reset 

func (x *CountMessageTokensRequest) Reset()

func (*CountMessageTokensRequest) String 

func (x *CountMessageTokensRequest) String() string

type CountMessageTokensResponse 

type CountMessageTokensResponse struct {

	// The number of tokens that the `model` tokenizes the `prompt` into.
	//
	// Always non-negative.
	TokenCount int32 `protobuf:"varint,1,opt,name=token_count,json=tokenCount,proto3" json:"token_count,omitempty"`
	// contains filtered or unexported fields
}

A response from `CountMessageTokens`.

It returns the model's `token_count` for the `prompt`.

func (*CountMessageTokensResponse) Descriptor deprecated 

func (*CountMessageTokensResponse) Descriptor() ([]byte, []int)

Deprecated: Use CountMessageTokensResponse.ProtoReflect.Descriptor instead.

func (*CountMessageTokensResponse) GetTokenCount 

func (x *CountMessageTokensResponse) GetTokenCount() int32

func (*CountMessageTokensResponse) ProtoMessage 

func (*CountMessageTokensResponse) ProtoMessage()

func (*CountMessageTokensResponse) ProtoReflect 

func (x *CountMessageTokensResponse) ProtoReflect() protoreflect.Message

func (*CountMessageTokensResponse) Reset 

func (x *CountMessageTokensResponse) Reset()

func (*CountMessageTokensResponse) String 

func (x *CountMessageTokensResponse) String() string

type CountTextTokensRequest 

type CountTextTokensRequest struct {

	// Required. The model's resource name. This serves as an ID for the Model to
	// use.
	//
	// This name should match a model name returned by the `ListModels` method.
	//
	// Format: `models/{model}`
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Required. The free-form input text given to the model as a prompt.
	Prompt *TextPrompt `protobuf:"bytes,2,opt,name=prompt,proto3" json:"prompt,omitempty"`
	// contains filtered or unexported fields
}

Counts the number of tokens in the `prompt` sent to a model.

Models may tokenize text differently, so each model may return a different `token_count`.

func (*CountTextTokensRequest) Descriptor deprecated 

func (*CountTextTokensRequest) Descriptor() ([]byte, []int)

Deprecated: Use CountTextTokensRequest.ProtoReflect.Descriptor instead.

func (*CountTextTokensRequest) GetModel 

func (x *CountTextTokensRequest) GetModel() string

func (*CountTextTokensRequest) GetPrompt 

func (x *CountTextTokensRequest) GetPrompt() *TextPrompt

func (*CountTextTokensRequest) ProtoMessage 

func (*CountTextTokensRequest) ProtoMessage()

func (*CountTextTokensRequest) ProtoReflect 

func (x *CountTextTokensRequest) ProtoReflect() protoreflect.Message

func (*CountTextTokensRequest) Reset 

func (x *CountTextTokensRequest) Reset()

func (*CountTextTokensRequest) String 

func (x *CountTextTokensRequest) String() string

type CountTextTokensResponse 

type CountTextTokensResponse struct {

	// The number of tokens that the `model` tokenizes the `prompt` into.
	//
	// Always non-negative.
	TokenCount int32 `protobuf:"varint,1,opt,name=token_count,json=tokenCount,proto3" json:"token_count,omitempty"`
	// contains filtered or unexported fields
}

A response from `CountTextTokens`.

It returns the model's `token_count` for the `prompt`.

func (*CountTextTokensResponse) Descriptor deprecated 

func (*CountTextTokensResponse) Descriptor() ([]byte, []int)

Deprecated: Use CountTextTokensResponse.ProtoReflect.Descriptor instead.

func (*CountTextTokensResponse) GetTokenCount 

func (x *CountTextTokensResponse) GetTokenCount() int32

func (*CountTextTokensResponse) ProtoMessage 

func (*CountTextTokensResponse) ProtoMessage()

func (*CountTextTokensResponse) ProtoReflect 

func (x *CountTextTokensResponse) ProtoReflect() protoreflect.Message

func (*CountTextTokensResponse) Reset 

func (x *CountTextTokensResponse) Reset()

func (*CountTextTokensResponse) String 

func (x *CountTextTokensResponse) String() string

type CountTokensRequest 

type CountTokensRequest struct {

	// Required. The model's resource name. This serves as an ID for the Model to
	// use.
	//
	// This name should match a model name returned by the `ListModels` method.
	//
	// Format: `models/{model}`
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Required. The input given to the model as a prompt.
	Contents []*Content `protobuf:"bytes,2,rep,name=contents,proto3" json:"contents,omitempty"`
	// contains filtered or unexported fields
}

Counts the number of tokens in the `prompt` sent to a model.

Models may tokenize text differently, so each model may return a different `token_count`.

func (*CountTokensRequest) Descriptor deprecated 

func (*CountTokensRequest) Descriptor() ([]byte, []int)

Deprecated: Use CountTokensRequest.ProtoReflect.Descriptor instead.

func (*CountTokensRequest) GetContents 

func (x *CountTokensRequest) GetContents() []*Content

func (*CountTokensRequest) GetModel 

func (x *CountTokensRequest) GetModel() string

func (*CountTokensRequest) ProtoMessage 

func (*CountTokensRequest) ProtoMessage()

func (*CountTokensRequest) ProtoReflect 

func (x *CountTokensRequest) ProtoReflect() protoreflect.Message

func (*CountTokensRequest) Reset 

func (x *CountTokensRequest) Reset()

func (*CountTokensRequest) String 

func (x *CountTokensRequest) String() string

type CountTokensResponse 

type CountTokensResponse struct {

	// The number of tokens that the `model` tokenizes the `prompt` into.
	//
	// Always non-negative.
	TotalTokens int32 `protobuf:"varint,1,opt,name=total_tokens,json=totalTokens,proto3" json:"total_tokens,omitempty"`
	// contains filtered or unexported fields
}

A response from `CountTokens`.

It returns the model's `token_count` for the `prompt`.

func (*CountTokensResponse) Descriptor deprecated 

func (*CountTokensResponse) Descriptor() ([]byte, []int)

Deprecated: Use CountTokensResponse.ProtoReflect.Descriptor instead.

func (*CountTokensResponse) GetTotalTokens 

func (x *CountTokensResponse) GetTotalTokens() int32

func (*CountTokensResponse) ProtoMessage 

func (*CountTokensResponse) ProtoMessage()

func (*CountTokensResponse) ProtoReflect 

func (x *CountTokensResponse) ProtoReflect() protoreflect.Message

func (*CountTokensResponse) Reset 

func (x *CountTokensResponse) Reset()

func (*CountTokensResponse) String 

func (x *CountTokensResponse) String() string

type CreateChunkRequest 

type CreateChunkRequest struct {

	// Required. The name of the `Document` where this `Chunk` will be created.
	// Example: `corpora/my-corpus-123/documents/the-doc-abc`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The `Chunk` to create.
	Chunk *Chunk `protobuf:"bytes,2,opt,name=chunk,proto3" json:"chunk,omitempty"`
	// contains filtered or unexported fields
}

Request to create a `Chunk`.

func (*CreateChunkRequest) Descriptor deprecated 

func (*CreateChunkRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateChunkRequest.ProtoReflect.Descriptor instead.

func (*CreateChunkRequest) GetChunk 

func (x *CreateChunkRequest) GetChunk() *Chunk

func (*CreateChunkRequest) GetParent 

func (x *CreateChunkRequest) GetParent() string

func (*CreateChunkRequest) ProtoMessage 

func (*CreateChunkRequest) ProtoMessage()

func (*CreateChunkRequest) ProtoReflect 

func (x *CreateChunkRequest) ProtoReflect() protoreflect.Message

func (*CreateChunkRequest) Reset 

func (x *CreateChunkRequest) Reset()

func (*CreateChunkRequest) String 

func (x *CreateChunkRequest) String() string

type CreateCorpusRequest 

type CreateCorpusRequest struct {

	// Required. The `Corpus` to create.
	Corpus *Corpus `protobuf:"bytes,1,opt,name=corpus,proto3" json:"corpus,omitempty"`
	// contains filtered or unexported fields
}

Request to create a `Corpus`.

func (*CreateCorpusRequest) Descriptor deprecated 

func (*CreateCorpusRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateCorpusRequest.ProtoReflect.Descriptor instead.

func (*CreateCorpusRequest) GetCorpus 

func (x *CreateCorpusRequest) GetCorpus() *Corpus

func (*CreateCorpusRequest) ProtoMessage 

func (*CreateCorpusRequest) ProtoMessage()

func (*CreateCorpusRequest) ProtoReflect 

func (x *CreateCorpusRequest) ProtoReflect() protoreflect.Message

func (*CreateCorpusRequest) Reset 

func (x *CreateCorpusRequest) Reset()

func (*CreateCorpusRequest) String 

func (x *CreateCorpusRequest) String() string

type CreateDocumentRequest 

type CreateDocumentRequest struct {

	// Required. The name of the `Corpus` where this `Document` will be created.
	// Example: `corpora/my-corpus-123`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The `Document` to create.
	Document *Document `protobuf:"bytes,2,opt,name=document,proto3" json:"document,omitempty"`
	// contains filtered or unexported fields
}

Request to create a `Document`.

func (*CreateDocumentRequest) Descriptor deprecated 

func (*CreateDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateDocumentRequest.ProtoReflect.Descriptor instead.

func (*CreateDocumentRequest) GetDocument 

func (x *CreateDocumentRequest) GetDocument() *Document

func (*CreateDocumentRequest) GetParent 

func (x *CreateDocumentRequest) GetParent() string

func (*CreateDocumentRequest) ProtoMessage 

func (*CreateDocumentRequest) ProtoMessage()

func (*CreateDocumentRequest) ProtoReflect 

func (x *CreateDocumentRequest) ProtoReflect() protoreflect.Message

func (*CreateDocumentRequest) Reset 

func (x *CreateDocumentRequest) Reset()

func (*CreateDocumentRequest) String 

func (x *CreateDocumentRequest) String() string

type CreateFileRequest 

type CreateFileRequest struct {

	// Optional. Metadata for the file to create.
	File *File `protobuf:"bytes,1,opt,name=file,proto3" json:"file,omitempty"`
	// contains filtered or unexported fields
}

Request for `CreateFile`.

func (*CreateFileRequest) Descriptor deprecated 

func (*CreateFileRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateFileRequest.ProtoReflect.Descriptor instead.

func (*CreateFileRequest) GetFile 

func (x *CreateFileRequest) GetFile() *File

func (*CreateFileRequest) ProtoMessage 

func (*CreateFileRequest) ProtoMessage()

func (*CreateFileRequest) ProtoReflect 

func (x *CreateFileRequest) ProtoReflect() protoreflect.Message

func (*CreateFileRequest) Reset 

func (x *CreateFileRequest) Reset()

func (*CreateFileRequest) String 

func (x *CreateFileRequest) String() string

type CreateFileResponse 

type CreateFileResponse struct {

	// Metadata for the created file.
	File *File `protobuf:"bytes,1,opt,name=file,proto3" json:"file,omitempty"`
	// contains filtered or unexported fields
}

Response for `CreateFile`.

func (*CreateFileResponse) Descriptor deprecated 

func (*CreateFileResponse) Descriptor() ([]byte, []int)

Deprecated: Use CreateFileResponse.ProtoReflect.Descriptor instead.

func (*CreateFileResponse) GetFile 

func (x *CreateFileResponse) GetFile() *File

func (*CreateFileResponse) ProtoMessage 

func (*CreateFileResponse) ProtoMessage()

func (*CreateFileResponse) ProtoReflect 

func (x *CreateFileResponse) ProtoReflect() protoreflect.Message

func (*CreateFileResponse) Reset 

func (x *CreateFileResponse) Reset()

func (*CreateFileResponse) String 

func (x *CreateFileResponse) String() string

type CreatePermissionRequest 

type CreatePermissionRequest struct {

	// Required. The parent resource of the `Permission`.
	// Formats:
	//
	//	`tunedModels/{tuned_model}`
	//	`corpora/{corpus}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. The permission to create.
	Permission *Permission `protobuf:"bytes,2,opt,name=permission,proto3" json:"permission,omitempty"`
	// contains filtered or unexported fields
}

Request to create a `Permission`.

func (*CreatePermissionRequest) Descriptor deprecated 

func (*CreatePermissionRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreatePermissionRequest.ProtoReflect.Descriptor instead.

func (*CreatePermissionRequest) GetParent 

func (x *CreatePermissionRequest) GetParent() string

func (*CreatePermissionRequest) GetPermission 

func (x *CreatePermissionRequest) GetPermission() *Permission

func (*CreatePermissionRequest) ProtoMessage 

func (*CreatePermissionRequest) ProtoMessage()

func (*CreatePermissionRequest) ProtoReflect 

func (x *CreatePermissionRequest) ProtoReflect() protoreflect.Message

func (*CreatePermissionRequest) Reset 

func (x *CreatePermissionRequest) Reset()

func (*CreatePermissionRequest) String 

func (x *CreatePermissionRequest) String() string

type CreateTunedModelMetadata 

type CreateTunedModelMetadata struct {

	// Name of the tuned model associated with the tuning operation.
	TunedModel string `protobuf:"bytes,5,opt,name=tuned_model,json=tunedModel,proto3" json:"tuned_model,omitempty"`
	// The total number of tuning steps.
	TotalSteps int32 `protobuf:"varint,1,opt,name=total_steps,json=totalSteps,proto3" json:"total_steps,omitempty"`
	// The number of steps completed.
	CompletedSteps int32 `protobuf:"varint,2,opt,name=completed_steps,json=completedSteps,proto3" json:"completed_steps,omitempty"`
	// The completed percentage for the tuning operation.
	CompletedPercent float32 `protobuf:"fixed32,3,opt,name=completed_percent,json=completedPercent,proto3" json:"completed_percent,omitempty"`
	// Metrics collected during tuning.
	Snapshots []*TuningSnapshot `protobuf:"bytes,4,rep,name=snapshots,proto3" json:"snapshots,omitempty"`
	// contains filtered or unexported fields
}

Metadata about the state and progress of creating a tuned model returned from the long-running operation

func (*CreateTunedModelMetadata) Descriptor deprecated 

func (*CreateTunedModelMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CreateTunedModelMetadata.ProtoReflect.Descriptor instead.

func (*CreateTunedModelMetadata) GetCompletedPercent 

func (x *CreateTunedModelMetadata) GetCompletedPercent() float32

func (*CreateTunedModelMetadata) GetCompletedSteps 

func (x *CreateTunedModelMetadata) GetCompletedSteps() int32

func (*CreateTunedModelMetadata) GetSnapshots 

func (x *CreateTunedModelMetadata) GetSnapshots() []*TuningSnapshot

func (*CreateTunedModelMetadata) GetTotalSteps 

func (x *CreateTunedModelMetadata) GetTotalSteps() int32

func (*CreateTunedModelMetadata) GetTunedModel 

func (x *CreateTunedModelMetadata) GetTunedModel() string

func (*CreateTunedModelMetadata) ProtoMessage 

func (*CreateTunedModelMetadata) ProtoMessage()

func (*CreateTunedModelMetadata) ProtoReflect 

func (x *CreateTunedModelMetadata) ProtoReflect() protoreflect.Message

func (*CreateTunedModelMetadata) Reset 

func (x *CreateTunedModelMetadata) Reset()

func (*CreateTunedModelMetadata) String 

func (x *CreateTunedModelMetadata) String() string

type CreateTunedModelRequest 

type CreateTunedModelRequest struct {

	// Optional. The unique id for the tuned model if specified.
	// This value should be up to 40 characters, the first character must be a
	// letter, the last could be a letter or a number. The id must match the
	// regular expression: [a-z]([a-z0-9-]{0,38}[a-z0-9])?.
	TunedModelId *string `protobuf:"bytes,1,opt,name=tuned_model_id,json=tunedModelId,proto3,oneof" json:"tuned_model_id,omitempty"`
	// Required. The tuned model to create.
	TunedModel *TunedModel `protobuf:"bytes,2,opt,name=tuned_model,json=tunedModel,proto3" json:"tuned_model,omitempty"`
	// contains filtered or unexported fields
}

Request to create a TunedModel.

func (*CreateTunedModelRequest) Descriptor deprecated 

func (*CreateTunedModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use CreateTunedModelRequest.ProtoReflect.Descriptor instead.

func (*CreateTunedModelRequest) GetTunedModel 

func (x *CreateTunedModelRequest) GetTunedModel() *TunedModel

func (*CreateTunedModelRequest) GetTunedModelId 

func (x *CreateTunedModelRequest) GetTunedModelId() string

func (*CreateTunedModelRequest) ProtoMessage 

func (*CreateTunedModelRequest) ProtoMessage()

func (*CreateTunedModelRequest) ProtoReflect 

func (x *CreateTunedModelRequest) ProtoReflect() protoreflect.Message

func (*CreateTunedModelRequest) Reset 

func (x *CreateTunedModelRequest) Reset()

func (*CreateTunedModelRequest) String 

func (x *CreateTunedModelRequest) String() string

type CustomMetadata 

type CustomMetadata struct {

	// Types that are assignable to Value:
	//
	//	*CustomMetadata_StringValue
	//	*CustomMetadata_StringListValue
	//	*CustomMetadata_NumericValue
	Value isCustomMetadata_Value `protobuf_oneof:"value"`
	// Required. The key of the metadata to store.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

User provided metadata stored as key-value pairs.

func (*CustomMetadata) Descriptor deprecated 

func (*CustomMetadata) Descriptor() ([]byte, []int)

Deprecated: Use CustomMetadata.ProtoReflect.Descriptor instead.

func (*CustomMetadata) GetKey 

func (x *CustomMetadata) GetKey() string

func (*CustomMetadata) GetNumericValue 

func (x *CustomMetadata) GetNumericValue() float32

func (*CustomMetadata) GetStringListValue 

func (x *CustomMetadata) GetStringListValue() *StringList

func (*CustomMetadata) GetStringValue 

func (x *CustomMetadata) GetStringValue() string

func (*CustomMetadata) GetValue 

func (m *CustomMetadata) GetValue() isCustomMetadata_Value

func (*CustomMetadata) ProtoMessage 

func (*CustomMetadata) ProtoMessage()

func (*CustomMetadata) ProtoReflect 

func (x *CustomMetadata) ProtoReflect() protoreflect.Message

func (*CustomMetadata) Reset 

func (x *CustomMetadata) Reset()

func (*CustomMetadata) String 

func (x *CustomMetadata) String() string

type CustomMetadata_NumericValue 

type CustomMetadata_NumericValue struct {
	// The numeric value of the metadata to store.
	NumericValue float32 `protobuf:"fixed32,7,opt,name=numeric_value,json=numericValue,proto3,oneof"`
}

type CustomMetadata_StringListValue 

type CustomMetadata_StringListValue struct {
	// The StringList value of the metadata to store.
	StringListValue *StringList `protobuf:"bytes,6,opt,name=string_list_value,json=stringListValue,proto3,oneof"`
}

type CustomMetadata_StringValue 

type CustomMetadata_StringValue struct {
	// The string value of the metadata to store.
	StringValue string `protobuf:"bytes,2,opt,name=string_value,json=stringValue,proto3,oneof"`
}

type Dataset 

type Dataset struct {

	// Inline data or a reference to the data.
	//
	// Types that are assignable to Dataset:
	//
	//	*Dataset_Examples
	Dataset isDataset_Dataset `protobuf_oneof:"dataset"`
	// contains filtered or unexported fields
}

Dataset for training or validation.

func (*Dataset) Descriptor deprecated 

func (*Dataset) Descriptor() ([]byte, []int)

Deprecated: Use Dataset.ProtoReflect.Descriptor instead.

func (*Dataset) GetDataset 

func (m *Dataset) GetDataset() isDataset_Dataset

func (*Dataset) GetExamples 

func (x *Dataset) GetExamples() *TuningExamples

func (*Dataset) ProtoMessage 

func (*Dataset) ProtoMessage()

func (*Dataset) ProtoReflect 

func (x *Dataset) ProtoReflect() protoreflect.Message

func (*Dataset) Reset 

func (x *Dataset) Reset()

func (*Dataset) String 

func (x *Dataset) String() string

type Dataset_Examples 

type Dataset_Examples struct {
	// Optional. Inline examples.
	Examples *TuningExamples `protobuf:"bytes,1,opt,name=examples,proto3,oneof"`
}

type DeleteChunkRequest 

type DeleteChunkRequest struct {

	// Required. The resource name of the `Chunk` to delete.
	// Example: `corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request to delete a `Chunk`.

func (*DeleteChunkRequest) Descriptor deprecated 

func (*DeleteChunkRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteChunkRequest.ProtoReflect.Descriptor instead.

func (*DeleteChunkRequest) GetName 

func (x *DeleteChunkRequest) GetName() string

func (*DeleteChunkRequest) ProtoMessage 

func (*DeleteChunkRequest) ProtoMessage()

func (*DeleteChunkRequest) ProtoReflect 

func (x *DeleteChunkRequest) ProtoReflect() protoreflect.Message

func (*DeleteChunkRequest) Reset 

func (x *DeleteChunkRequest) Reset()

func (*DeleteChunkRequest) String 

func (x *DeleteChunkRequest) String() string

type DeleteCorpusRequest 

type DeleteCorpusRequest struct {

	// Required. The resource name of the `Corpus`.
	// Example: `corpora/my-corpus-123`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. If set to true, any `Document`s and objects related to this
	// `Corpus` will also be deleted.
	//
	// If false (the default), a `FAILED_PRECONDITION` error will be returned if
	// `Corpus` contains any `Document`s.
	Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request to delete a `Corpus`.

func (*DeleteCorpusRequest) Descriptor deprecated 

func (*DeleteCorpusRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteCorpusRequest.ProtoReflect.Descriptor instead.

func (*DeleteCorpusRequest) GetForce 

func (x *DeleteCorpusRequest) GetForce() bool

func (*DeleteCorpusRequest) GetName 

func (x *DeleteCorpusRequest) GetName() string

func (*DeleteCorpusRequest) ProtoMessage 

func (*DeleteCorpusRequest) ProtoMessage()

func (*DeleteCorpusRequest) ProtoReflect 

func (x *DeleteCorpusRequest) ProtoReflect() protoreflect.Message

func (*DeleteCorpusRequest) Reset 

func (x *DeleteCorpusRequest) Reset()

func (*DeleteCorpusRequest) String 

func (x *DeleteCorpusRequest) String() string

type DeleteDocumentRequest 

type DeleteDocumentRequest struct {

	// Required. The resource name of the `Document` to delete.
	// Example: `corpora/my-corpus-123/documents/the-doc-abc`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. If set to true, any `Chunk`s and objects related to this
	// `Document` will also be deleted.
	//
	// If false (the default), a `FAILED_PRECONDITION` error will be returned if
	// `Document` contains any `Chunk`s.
	Force bool `protobuf:"varint,2,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Request to delete a `Document`.

func (*DeleteDocumentRequest) Descriptor deprecated 

func (*DeleteDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteDocumentRequest.ProtoReflect.Descriptor instead.

func (*DeleteDocumentRequest) GetForce 

func (x *DeleteDocumentRequest) GetForce() bool

func (*DeleteDocumentRequest) GetName 

func (x *DeleteDocumentRequest) GetName() string

func (*DeleteDocumentRequest) ProtoMessage 

func (*DeleteDocumentRequest) ProtoMessage()

func (*DeleteDocumentRequest) ProtoReflect 

func (x *DeleteDocumentRequest) ProtoReflect() protoreflect.Message

func (*DeleteDocumentRequest) Reset 

func (x *DeleteDocumentRequest) Reset()

func (*DeleteDocumentRequest) String 

func (x *DeleteDocumentRequest) String() string

type DeleteFileRequest 

type DeleteFileRequest struct {

	// Required. The name of the `File` to delete.
	// Example: `files/abc-123`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for `DeleteFile`.

func (*DeleteFileRequest) Descriptor deprecated 

func (*DeleteFileRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteFileRequest.ProtoReflect.Descriptor instead.

func (*DeleteFileRequest) GetName 

func (x *DeleteFileRequest) GetName() string

func (*DeleteFileRequest) ProtoMessage 

func (*DeleteFileRequest) ProtoMessage()

func (*DeleteFileRequest) ProtoReflect 

func (x *DeleteFileRequest) ProtoReflect() protoreflect.Message

func (*DeleteFileRequest) Reset 

func (x *DeleteFileRequest) Reset()

func (*DeleteFileRequest) String 

func (x *DeleteFileRequest) String() string

type DeletePermissionRequest 

type DeletePermissionRequest struct {

	// Required. The resource name of the permission.
	// Formats:
	//
	//	`tunedModels/{tuned_model}/permissions/{permission}`
	//	`corpora/{corpus}/permissions/{permission}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request to delete the `Permission`.

func (*DeletePermissionRequest) Descriptor deprecated 

func (*DeletePermissionRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeletePermissionRequest.ProtoReflect.Descriptor instead.

func (*DeletePermissionRequest) GetName 

func (x *DeletePermissionRequest) GetName() string

func (*DeletePermissionRequest) ProtoMessage 

func (*DeletePermissionRequest) ProtoMessage()

func (*DeletePermissionRequest) ProtoReflect 

func (x *DeletePermissionRequest) ProtoReflect() protoreflect.Message

func (*DeletePermissionRequest) Reset 

func (x *DeletePermissionRequest) Reset()

func (*DeletePermissionRequest) String 

func (x *DeletePermissionRequest) String() string

type DeleteTunedModelRequest 

type DeleteTunedModelRequest struct {

	// Required. The resource name of the model.
	// Format: `tunedModels/my-model-id`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request to delete a TunedModel.

func (*DeleteTunedModelRequest) Descriptor deprecated 

func (*DeleteTunedModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeleteTunedModelRequest.ProtoReflect.Descriptor instead.

func (*DeleteTunedModelRequest) GetName 

func (x *DeleteTunedModelRequest) GetName() string

func (*DeleteTunedModelRequest) ProtoMessage 

func (*DeleteTunedModelRequest) ProtoMessage()

func (*DeleteTunedModelRequest) ProtoReflect 

func (x *DeleteTunedModelRequest) ProtoReflect() protoreflect.Message

func (*DeleteTunedModelRequest) Reset 

func (x *DeleteTunedModelRequest) Reset()

func (*DeleteTunedModelRequest) String 

func (x *DeleteTunedModelRequest) String() string

type DiscussServiceClient 

type DiscussServiceClient interface {
	// Generates a response from the model given an input `MessagePrompt`.
	GenerateMessage(ctx context.Context, in *GenerateMessageRequest, opts ...grpc.CallOption) (*GenerateMessageResponse, error)
	// Runs a model's tokenizer on a string and returns the token count.
	CountMessageTokens(ctx context.Context, in *CountMessageTokensRequest, opts ...grpc.CallOption) (*CountMessageTokensResponse, error)
}

DiscussServiceClient is the client API for DiscussService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewDiscussServiceClient 

func NewDiscussServiceClient(cc grpc.ClientConnInterface) DiscussServiceClient

type DiscussServiceServer 

type DiscussServiceServer interface {
	// Generates a response from the model given an input `MessagePrompt`.
	GenerateMessage(context.Context, *GenerateMessageRequest) (*GenerateMessageResponse, error)
	// Runs a model's tokenizer on a string and returns the token count.
	CountMessageTokens(context.Context, *CountMessageTokensRequest) (*CountMessageTokensResponse, error)
}

DiscussServiceServer is the server API for DiscussService service.

type Document 

type Document struct {

	// Immutable. Identifier. The `Document` resource name. The ID (name excluding
	// the "corpora/*/documents/" prefix) can contain up to 40 characters that are
	// lowercase alphanumeric or dashes (-). The ID cannot start or end with a
	// dash. If the name is empty on create, a unique name will be derived from
	// `display_name` along with a 12 character random suffix.
	// Example: `corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The human-readable display name for the `Document`. The display
	// name must be no more than 512 characters in length, including spaces.
	// Example: "Semantic Retriever Documentation"
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Optional. User provided custom metadata stored as key-value pairs used for
	// querying. A `Document` can have a maximum of 20 `CustomMetadata`.
	CustomMetadata []*CustomMetadata `protobuf:"bytes,3,rep,name=custom_metadata,json=customMetadata,proto3" json:"custom_metadata,omitempty"`
	// Output only. The Timestamp of when the `Document` was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. The Timestamp of when the `Document` was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// contains filtered or unexported fields
}

A `Document` is a collection of `Chunk`s. A `Corpus` can have a maximum of 10,000 `Document`s.

func (*Document) Descriptor deprecated 

func (*Document) Descriptor() ([]byte, []int)

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetCreateTime 

func (x *Document) GetCreateTime() *timestamppb.Timestamp

func (*Document) GetCustomMetadata 

func (x *Document) GetCustomMetadata() []*CustomMetadata

func (*Document) GetDisplayName 

func (x *Document) GetDisplayName() string

func (*Document) GetName 

func (x *Document) GetName() string

func (*Document) GetUpdateTime 

func (x *Document) GetUpdateTime() *timestamppb.Timestamp

func (*Document) ProtoMessage 

func (*Document) ProtoMessage()

func (*Document) ProtoReflect 

func (x *Document) ProtoReflect() protoreflect.Message

func (*Document) Reset 

func (x *Document) Reset()

func (*Document) String 

func (x *Document) String() string

type EmbedContentRequest 

type EmbedContentRequest struct {

	// Required. The model's resource name. This serves as an ID for the Model to
	// use.
	//
	// This name should match a model name returned by the `ListModels` method.
	//
	// Format: `models/{model}`
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Required. The content to embed. Only the `parts.text` fields will be
	// counted.
	Content *Content `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// Optional. Optional task type for which the embeddings will be used. Can
	// only be set for `models/embedding-001`.
	TaskType *TaskType `` /* 142-byte string literal not displayed */
	// Optional. An optional title for the text. Only applicable when TaskType is
	// `RETRIEVAL_DOCUMENT`.
	//
	// Note: Specifying a `title` for `RETRIEVAL_DOCUMENT` provides better quality
	// embeddings for retrieval.
	Title *string `protobuf:"bytes,4,opt,name=title,proto3,oneof" json:"title,omitempty"`
	// Optional. Optional reduced dimension for the output embedding. If set,
	// excessive values in the output embedding are truncated from the end.
	// Supported by `models/text-embedding-latest`.
	OutputDimensionality *int32 `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

Request containing the `Content` for the model to embed.

func (*EmbedContentRequest) Descriptor deprecated 

func (*EmbedContentRequest) Descriptor() ([]byte, []int)

Deprecated: Use EmbedContentRequest.ProtoReflect.Descriptor instead.

func (*EmbedContentRequest) GetContent 

func (x *EmbedContentRequest) GetContent() *Content

func (*EmbedContentRequest) GetModel 

func (x *EmbedContentRequest) GetModel() string

func (*EmbedContentRequest) GetOutputDimensionality 

func (x *EmbedContentRequest) GetOutputDimensionality() int32

func (*EmbedContentRequest) GetTaskType 

func (x *EmbedContentRequest) GetTaskType() TaskType

func (*EmbedContentRequest) GetTitle 

func (x *EmbedContentRequest) GetTitle() string

func (*EmbedContentRequest) ProtoMessage 

func (*EmbedContentRequest) ProtoMessage()

func (*EmbedContentRequest) ProtoReflect 

func (x *EmbedContentRequest) ProtoReflect() protoreflect.Message

func (*EmbedContentRequest) Reset 

func (x *EmbedContentRequest) Reset()

func (*EmbedContentRequest) String 

func (x *EmbedContentRequest) String() string

type EmbedContentResponse 

type EmbedContentResponse struct {

	// Output only. The embedding generated from the input content.
	Embedding *ContentEmbedding `protobuf:"bytes,1,opt,name=embedding,proto3" json:"embedding,omitempty"`
	// contains filtered or unexported fields
}

The response to an `EmbedContentRequest`.

func (*EmbedContentResponse) Descriptor deprecated 

func (*EmbedContentResponse) Descriptor() ([]byte, []int)

Deprecated: Use EmbedContentResponse.ProtoReflect.Descriptor instead.

func (*EmbedContentResponse) GetEmbedding 

func (x *EmbedContentResponse) GetEmbedding() *ContentEmbedding

func (*EmbedContentResponse) ProtoMessage 

func (*EmbedContentResponse) ProtoMessage()

func (*EmbedContentResponse) ProtoReflect 

func (x *EmbedContentResponse) ProtoReflect() protoreflect.Message

func (*EmbedContentResponse) Reset 

func (x *EmbedContentResponse) Reset()

func (*EmbedContentResponse) String 

func (x *EmbedContentResponse) String() string

type EmbedTextRequest 

type EmbedTextRequest struct {

	// Required. The model name to use with the format model=models/{model}.
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Optional. The free-form input text that the model will turn into an
	// embedding.
	Text string `protobuf:"bytes,2,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

Request to get a text embedding from the model.

func (*EmbedTextRequest) Descriptor deprecated 

func (*EmbedTextRequest) Descriptor() ([]byte, []int)

Deprecated: Use EmbedTextRequest.ProtoReflect.Descriptor instead.

func (*EmbedTextRequest) GetModel 

func (x *EmbedTextRequest) GetModel() string

func (*EmbedTextRequest) GetText 

func (x *EmbedTextRequest) GetText() string

func (*EmbedTextRequest) ProtoMessage 

func (*EmbedTextRequest) ProtoMessage()

func (*EmbedTextRequest) ProtoReflect 

func (x *EmbedTextRequest) ProtoReflect() protoreflect.Message

func (*EmbedTextRequest) Reset 

func (x *EmbedTextRequest) Reset()

func (*EmbedTextRequest) String 

func (x *EmbedTextRequest) String() string

type EmbedTextResponse 

type EmbedTextResponse struct {

	// Output only. The embedding generated from the input text.
	Embedding *Embedding `protobuf:"bytes,1,opt,name=embedding,proto3,oneof" json:"embedding,omitempty"`
	// contains filtered or unexported fields
}

The response to a EmbedTextRequest.

func (*EmbedTextResponse) Descriptor deprecated 

func (*EmbedTextResponse) Descriptor() ([]byte, []int)

Deprecated: Use EmbedTextResponse.ProtoReflect.Descriptor instead.

func (*EmbedTextResponse) GetEmbedding 

func (x *EmbedTextResponse) GetEmbedding() *Embedding

func (*EmbedTextResponse) ProtoMessage 

func (*EmbedTextResponse) ProtoMessage()

func (*EmbedTextResponse) ProtoReflect 

func (x *EmbedTextResponse) ProtoReflect() protoreflect.Message

func (*EmbedTextResponse) Reset 

func (x *EmbedTextResponse) Reset()

func (*EmbedTextResponse) String 

func (x *EmbedTextResponse) String() string

type Embedding 

type Embedding struct {

	// The embedding values.
	Value []float32 `protobuf:"fixed32,1,rep,packed,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

A list of floats representing the embedding.

func (*Embedding) Descriptor deprecated 

func (*Embedding) Descriptor() ([]byte, []int)

Deprecated: Use Embedding.ProtoReflect.Descriptor instead.

func (*Embedding) GetValue 

func (x *Embedding) GetValue() []float32

func (*Embedding) ProtoMessage 

func (*Embedding) ProtoMessage()

func (*Embedding) ProtoReflect 

func (x *Embedding) ProtoReflect() protoreflect.Message

func (*Embedding) Reset 

func (x *Embedding) Reset()

func (*Embedding) String 

func (x *Embedding) String() string

type Example 

type Example struct {

	// Required. An example of an input `Message` from the user.
	Input *Message `protobuf:"bytes,1,opt,name=input,proto3" json:"input,omitempty"`
	// Required. An example of what the model should output given the input.
	Output *Message `protobuf:"bytes,2,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

An input/output example used to instruct the Model.

It demonstrates how the model should respond or format its response.

func (*Example) Descriptor deprecated 

func (*Example) Descriptor() ([]byte, []int)

Deprecated: Use Example.ProtoReflect.Descriptor instead.

func (*Example) GetInput 

func (x *Example) GetInput() *Message

func (*Example) GetOutput 

func (x *Example) GetOutput() *Message

func (*Example) ProtoMessage 

func (*Example) ProtoMessage()

func (*Example) ProtoReflect 

func (x *Example) ProtoReflect() protoreflect.Message

func (*Example) Reset 

func (x *Example) Reset()

func (*Example) String 

func (x *Example) String() string

type File 

type File struct {

	// Immutable. Identifier. The `File` resource name. The ID (name excluding the
	// "files/" prefix) can contain up to 40 characters that are lowercase
	// alphanumeric or dashes (-). The ID cannot start or end with a dash. If the
	// name is empty on create, a unique name will be generated. Example:
	// `files/123-456`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The human-readable display name for the `File`. The display name
	// must be no more than 512 characters in length, including spaces. Example:
	// "Welcome Image"
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. MIME type of the file.
	MimeType string `protobuf:"bytes,3,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Output only. Size of the file in bytes.
	SizeBytes int64 `protobuf:"varint,4,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
	// Output only. The timestamp of when the `File` was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The timestamp of when the `File` was last updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. The timestamp of when the `File` will be deleted. Only set if
	// the `File` is scheduled to expire.
	ExpirationTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=expiration_time,json=expirationTime,proto3" json:"expiration_time,omitempty"`
	// Output only. SHA-256 hash of the uploaded bytes.
	Sha256Hash []byte `protobuf:"bytes,8,opt,name=sha256_hash,json=sha256Hash,proto3" json:"sha256_hash,omitempty"`
	// Output only. The uri of the `File`.
	Uri string `protobuf:"bytes,9,opt,name=uri,proto3" json:"uri,omitempty"`
	// contains filtered or unexported fields
}

A file uploaded to the API.

func (*File) Descriptor deprecated 

func (*File) Descriptor() ([]byte, []int)

Deprecated: Use File.ProtoReflect.Descriptor instead.

func (*File) GetCreateTime 

func (x *File) GetCreateTime() *timestamppb.Timestamp

func (*File) GetDisplayName 

func (x *File) GetDisplayName() string

func (*File) GetExpirationTime 

func (x *File) GetExpirationTime() *timestamppb.Timestamp

func (*File) GetMimeType 

func (x *File) GetMimeType() string

func (*File) GetName 

func (x *File) GetName() string

func (*File) GetSha256Hash 

func (x *File) GetSha256Hash() []byte

func (*File) GetSizeBytes 

func (x *File) GetSizeBytes() int64

func (*File) GetUpdateTime 

func (x *File) GetUpdateTime() *timestamppb.Timestamp

func (*File) GetUri 

func (x *File) GetUri() string

func (*File) ProtoMessage 

func (*File) ProtoMessage()

func (*File) ProtoReflect 

func (x *File) ProtoReflect() protoreflect.Message

func (*File) Reset 

func (x *File) Reset()

func (*File) String 

func (x *File) String() string

type FileData 

type FileData struct {

	// Optional. The IANA standard MIME type of the source data.
	MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// Required. URI.
	FileUri string `protobuf:"bytes,2,opt,name=file_uri,json=fileUri,proto3" json:"file_uri,omitempty"`
	// contains filtered or unexported fields
}

URI based data.

func (*FileData) Descriptor deprecated 

func (*FileData) Descriptor() ([]byte, []int)

Deprecated: Use FileData.ProtoReflect.Descriptor instead.

func (*FileData) GetFileUri 

func (x *FileData) GetFileUri() string

func (*FileData) GetMimeType 

func (x *FileData) GetMimeType() string

func (*FileData) ProtoMessage 

func (*FileData) ProtoMessage()

func (*FileData) ProtoReflect 

func (x *FileData) ProtoReflect() protoreflect.Message

func (*FileData) Reset 

func (x *FileData) Reset()

func (*FileData) String 

func (x *FileData) String() string

type FileServiceClient 

type FileServiceClient interface {
	// Creates a `File`.
	CreateFile(ctx context.Context, in *CreateFileRequest, opts ...grpc.CallOption) (*CreateFileResponse, error)
	// Lists the metadata for `File`s owned by the requesting project.
	ListFiles(ctx context.Context, in *ListFilesRequest, opts ...grpc.CallOption) (*ListFilesResponse, error)
	// Gets the metadata for the given `File`.
	GetFile(ctx context.Context, in *GetFileRequest, opts ...grpc.CallOption) (*File, error)
	// Deletes the `File`.
	DeleteFile(ctx context.Context, in *DeleteFileRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

FileServiceClient is the client API for FileService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewFileServiceClient 

func NewFileServiceClient(cc grpc.ClientConnInterface) FileServiceClient

type FileServiceServer 

type FileServiceServer interface {
	// Creates a `File`.
	CreateFile(context.Context, *CreateFileRequest) (*CreateFileResponse, error)
	// Lists the metadata for `File`s owned by the requesting project.
	ListFiles(context.Context, *ListFilesRequest) (*ListFilesResponse, error)
	// Gets the metadata for the given `File`.
	GetFile(context.Context, *GetFileRequest) (*File, error)
	// Deletes the `File`.
	DeleteFile(context.Context, *DeleteFileRequest) (*emptypb.Empty, error)
}

FileServiceServer is the server API for FileService service.

type FunctionCall 

type FunctionCall struct {

	// Required. The name of the function to call.
	// Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum
	// length of 63.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The function parameters and values in JSON object format.
	Args *structpb.Struct `protobuf:"bytes,2,opt,name=args,proto3,oneof" json:"args,omitempty"`
	// contains filtered or unexported fields
}

A predicted `FunctionCall` returned from the model that contains a string representing the `FunctionDeclaration.name` with the arguments and their values.

func (*FunctionCall) Descriptor deprecated 

func (*FunctionCall) Descriptor() ([]byte, []int)

Deprecated: Use FunctionCall.ProtoReflect.Descriptor instead.

func (*FunctionCall) GetArgs 

func (x *FunctionCall) GetArgs() *structpb.Struct

func (*FunctionCall) GetName 

func (x *FunctionCall) GetName() string

func (*FunctionCall) ProtoMessage 

func (*FunctionCall) ProtoMessage()

func (*FunctionCall) ProtoReflect 

func (x *FunctionCall) ProtoReflect() protoreflect.Message

func (*FunctionCall) Reset 

func (x *FunctionCall) Reset()

func (*FunctionCall) String 

func (x *FunctionCall) String() string

type FunctionCallingConfig 

type FunctionCallingConfig struct {

	// Optional. Specifies the mode in which function calling should execute. If
	// unspecified, the default value will be set to AUTO.
	Mode FunctionCallingConfig_Mode `` /* 130-byte string literal not displayed */
	// Optional. A set of function names that, when provided, limits the functions
	// the model will call.
	//
	// This should only be set when the Mode is ANY. Function names
	// should match [FunctionDeclaration.name]. With mode set to ANY, model will
	// predict a function call from the set of function names provided.
	AllowedFunctionNames []string `protobuf:"bytes,2,rep,name=allowed_function_names,json=allowedFunctionNames,proto3" json:"allowed_function_names,omitempty"`
	// contains filtered or unexported fields
}

Configuration for specifying function calling behavior.

func (*FunctionCallingConfig) Descriptor deprecated 

func (*FunctionCallingConfig) Descriptor() ([]byte, []int)

Deprecated: Use FunctionCallingConfig.ProtoReflect.Descriptor instead.

func (*FunctionCallingConfig) GetAllowedFunctionNames 

func (x *FunctionCallingConfig) GetAllowedFunctionNames() []string

func (*FunctionCallingConfig) GetMode 

func (x *FunctionCallingConfig) GetMode() FunctionCallingConfig_Mode

func (*FunctionCallingConfig) ProtoMessage 

func (*FunctionCallingConfig) ProtoMessage()

func (*FunctionCallingConfig) ProtoReflect 

func (x *FunctionCallingConfig) ProtoReflect() protoreflect.Message

func (*FunctionCallingConfig) Reset 

func (x *FunctionCallingConfig) Reset()

func (*FunctionCallingConfig) String 

func (x *FunctionCallingConfig) String() string

type FunctionCallingConfig_Mode 

type FunctionCallingConfig_Mode int32

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

const (
	// Unspecified function calling mode. This value should not be used.
	FunctionCallingConfig_MODE_UNSPECIFIED FunctionCallingConfig_Mode = 0
	// Default model behavior, model decides to predict either a function call
	// or a natural language repspose.
	FunctionCallingConfig_AUTO FunctionCallingConfig_Mode = 1
	// Model is constrained to always predicting a function call only.
	// If "allowed_function_names" are set, the predicted function call will be
	// limited to any one of "allowed_function_names", else the predicted
	// function call will be any one of the provided "function_declarations".
	FunctionCallingConfig_ANY FunctionCallingConfig_Mode = 2
	// Model will not predict any function call. Model behavior is same as when
	// not passing any function declarations.
	FunctionCallingConfig_NONE FunctionCallingConfig_Mode = 3
)

func (FunctionCallingConfig_Mode) Descriptor 

func (FunctionCallingConfig_Mode) Descriptor() protoreflect.EnumDescriptor

func (FunctionCallingConfig_Mode) Enum 

func (x FunctionCallingConfig_Mode) Enum() *FunctionCallingConfig_Mode

func (FunctionCallingConfig_Mode) EnumDescriptor deprecated 

func (FunctionCallingConfig_Mode) EnumDescriptor() ([]byte, []int)

Deprecated: Use FunctionCallingConfig_Mode.Descriptor instead.

func (FunctionCallingConfig_Mode) Number 

func (x FunctionCallingConfig_Mode) Number() protoreflect.EnumNumber

func (FunctionCallingConfig_Mode) String 

func (x FunctionCallingConfig_Mode) String() string

func (FunctionCallingConfig_Mode) Type 

func (FunctionCallingConfig_Mode) Type() protoreflect.EnumType

type FunctionDeclaration 

type FunctionDeclaration struct {

	// Required. The name of the function.
	// Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum
	// length of 63.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. A brief description of the function.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. Describes the parameters to this function. Reflects the Open
	// API 3.03 Parameter Object string Key: the name of the parameter. Parameter
	// names are case sensitive. Schema Value: the Schema defining the type used
	// for the parameter.
	Parameters *Schema `protobuf:"bytes,3,opt,name=parameters,proto3,oneof" json:"parameters,omitempty"`
	// contains filtered or unexported fields
}

Structured representation of a function declaration as defined by the [OpenAPI 3.03 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.

func (*FunctionDeclaration) Descriptor deprecated 

func (*FunctionDeclaration) Descriptor() ([]byte, []int)

Deprecated: Use FunctionDeclaration.ProtoReflect.Descriptor instead.

func (*FunctionDeclaration) GetDescription 

func (x *FunctionDeclaration) GetDescription() string

func (*FunctionDeclaration) GetName 

func (x *FunctionDeclaration) GetName() string

func (*FunctionDeclaration) GetParameters 

func (x *FunctionDeclaration) GetParameters() *Schema

func (*FunctionDeclaration) ProtoMessage 

func (*FunctionDeclaration) ProtoMessage()

func (*FunctionDeclaration) ProtoReflect 

func (x *FunctionDeclaration) ProtoReflect() protoreflect.Message

func (*FunctionDeclaration) Reset 

func (x *FunctionDeclaration) Reset()

func (*FunctionDeclaration) String 

func (x *FunctionDeclaration) String() string

type FunctionResponse 

type FunctionResponse struct {

	// Required. The name of the function to call.
	// Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum
	// length of 63.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The function response in JSON object format.
	Response *structpb.Struct `protobuf:"bytes,2,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

The result output from a `FunctionCall` that contains a string representing the `FunctionDeclaration.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.

func (*FunctionResponse) Descriptor deprecated 

func (*FunctionResponse) Descriptor() ([]byte, []int)

Deprecated: Use FunctionResponse.ProtoReflect.Descriptor instead.

func (*FunctionResponse) GetName 

func (x *FunctionResponse) GetName() string

func (*FunctionResponse) GetResponse 

func (x *FunctionResponse) GetResponse() *structpb.Struct

func (*FunctionResponse) ProtoMessage 

func (*FunctionResponse) ProtoMessage()

func (*FunctionResponse) ProtoReflect 

func (x *FunctionResponse) ProtoReflect() protoreflect.Message

func (*FunctionResponse) Reset 

func (x *FunctionResponse) Reset()

func (*FunctionResponse) String 

func (x *FunctionResponse) String() string

type GenerateAnswerRequest 

type GenerateAnswerRequest struct {

	// The sources in which to ground the answer.
	//
	// Types that are assignable to GroundingSource:
	//
	//	*GenerateAnswerRequest_InlinePassages
	//	*GenerateAnswerRequest_SemanticRetriever
	GroundingSource isGenerateAnswerRequest_GroundingSource `protobuf_oneof:"grounding_source"`
	// Required. The name of the `Model` to use for generating the grounded
	// response.
	//
	// Format: `model=models/{model}`.
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Required. The content of the current conversation with the model. For
	// single-turn queries, this is a single question to answer. For multi-turn
	// queries, this is a repeated field that contains conversation history and
	// the last `Content` in the list containing the question.
	//
	// Note: GenerateAnswer currently only supports queries in English.
	Contents []*Content `protobuf:"bytes,2,rep,name=contents,proto3" json:"contents,omitempty"`
	// Required. Style in which answers should be returned.
	AnswerStyle GenerateAnswerRequest_AnswerStyle `` /* 170-byte string literal not displayed */
	// Optional. A list of unique `SafetySetting` instances for blocking unsafe
	// content.
	//
	// This will be enforced on the `GenerateAnswerRequest.contents` and
	// `GenerateAnswerResponse.candidate`. There should not be more than one
	// setting for each `SafetyCategory` type. The API will block any contents and
	// responses that fail to meet the thresholds set by these settings. This list
	// overrides the default settings for each `SafetyCategory` specified in the
	// safety_settings. If there is no `SafetySetting` for a given
	// `SafetyCategory` provided in the list, the API will use the default safety
	// setting for that category. Harm categories HARM_CATEGORY_HATE_SPEECH,
	// HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT,
	// HARM_CATEGORY_HARASSMENT are supported.
	SafetySettings []*SafetySetting `protobuf:"bytes,3,rep,name=safety_settings,json=safetySettings,proto3" json:"safety_settings,omitempty"`
	// Optional. Controls the randomness of the output.
	//
	// Values can range from [0.0,1.0], inclusive. A value closer to 1.0 will
	// produce responses that are more varied and creative, while a value closer
	// to 0.0 will typically result in more straightforward responses from the
	// model. A low temperature (~0.2) is usually recommended for
	// Attributed-Question-Answering use cases.
	Temperature *float32 `protobuf:"fixed32,4,opt,name=temperature,proto3,oneof" json:"temperature,omitempty"`
	// contains filtered or unexported fields
}

Request to generate a grounded answer from the model.

func (*GenerateAnswerRequest) Descriptor deprecated 

func (*GenerateAnswerRequest) Descriptor() ([]byte, []int)

Deprecated: Use GenerateAnswerRequest.ProtoReflect.Descriptor instead.

func (*GenerateAnswerRequest) GetAnswerStyle 

func (x *GenerateAnswerRequest) GetAnswerStyle() GenerateAnswerRequest_AnswerStyle

func (*GenerateAnswerRequest) GetContents 

func (x *GenerateAnswerRequest) GetContents() []*Content

func (*GenerateAnswerRequest) GetGroundingSource 

func (m *GenerateAnswerRequest) GetGroundingSource() isGenerateAnswerRequest_GroundingSource

func (*GenerateAnswerRequest) GetInlinePassages 

func (x *GenerateAnswerRequest) GetInlinePassages() *GroundingPassages

func (*GenerateAnswerRequest) GetModel 

func (x *GenerateAnswerRequest) GetModel() string

func (*GenerateAnswerRequest) GetSafetySettings 

func (x *GenerateAnswerRequest) GetSafetySettings() []*SafetySetting

func (*GenerateAnswerRequest) GetSemanticRetriever 

func (x *GenerateAnswerRequest) GetSemanticRetriever() *SemanticRetrieverConfig

func (*GenerateAnswerRequest) GetTemperature 

func (x *GenerateAnswerRequest) GetTemperature() float32

func (*GenerateAnswerRequest) ProtoMessage 

func (*GenerateAnswerRequest) ProtoMessage()

func (*GenerateAnswerRequest) ProtoReflect 

func (x *GenerateAnswerRequest) ProtoReflect() protoreflect.Message

func (*GenerateAnswerRequest) Reset 

func (x *GenerateAnswerRequest) Reset()

func (*GenerateAnswerRequest) String 

func (x *GenerateAnswerRequest) String() string

type GenerateAnswerRequest_AnswerStyle 

type GenerateAnswerRequest_AnswerStyle int32

Style for grounded answers. 

const (
	// Unspecified answer style.
	GenerateAnswerRequest_ANSWER_STYLE_UNSPECIFIED GenerateAnswerRequest_AnswerStyle = 0
	// Succint but abstract style.
	GenerateAnswerRequest_ABSTRACTIVE GenerateAnswerRequest_AnswerStyle = 1
	// Very brief and extractive style.
	GenerateAnswerRequest_EXTRACTIVE GenerateAnswerRequest_AnswerStyle = 2
	// Verbose style including extra details. The response may be formatted as a
	// sentence, paragraph, multiple paragraphs, or bullet points, etc.
	GenerateAnswerRequest_VERBOSE GenerateAnswerRequest_AnswerStyle = 3
)

func (GenerateAnswerRequest_AnswerStyle) Descriptor 

func (GenerateAnswerRequest_AnswerStyle) Descriptor() protoreflect.EnumDescriptor

func (GenerateAnswerRequest_AnswerStyle) Enum 

func (x GenerateAnswerRequest_AnswerStyle) Enum() *GenerateAnswerRequest_AnswerStyle

func (GenerateAnswerRequest_AnswerStyle) EnumDescriptor deprecated 

func (GenerateAnswerRequest_AnswerStyle) EnumDescriptor() ([]byte, []int)

Deprecated: Use GenerateAnswerRequest_AnswerStyle.Descriptor instead.

func (GenerateAnswerRequest_AnswerStyle) Number 

func (x GenerateAnswerRequest_AnswerStyle) Number() protoreflect.EnumNumber

func (GenerateAnswerRequest_AnswerStyle) String 

func (x GenerateAnswerRequest_AnswerStyle) String() string

func (GenerateAnswerRequest_AnswerStyle) Type 

func (GenerateAnswerRequest_AnswerStyle) Type() protoreflect.EnumType

type GenerateAnswerRequest_InlinePassages 

type GenerateAnswerRequest_InlinePassages struct {
	// Passages provided inline with the request.
	InlinePassages *GroundingPassages `protobuf:"bytes,6,opt,name=inline_passages,json=inlinePassages,proto3,oneof"`
}

type GenerateAnswerRequest_SemanticRetriever 

type GenerateAnswerRequest_SemanticRetriever struct {
	// Content retrieved from resources created via the Semantic Retriever
	// API.
	SemanticRetriever *SemanticRetrieverConfig `protobuf:"bytes,7,opt,name=semantic_retriever,json=semanticRetriever,proto3,oneof"`
}

type GenerateAnswerResponse 

type GenerateAnswerResponse struct {

	// Candidate answer from the model.
	//
	// Note: The model *always* attempts to provide a grounded answer, even when
	// the answer is unlikely to be answerable from the given passages.
	// In that case, a low-quality or ungrounded answer may be provided, along
	// with a low `answerable_probability`.
	Answer *Candidate `protobuf:"bytes,1,opt,name=answer,proto3" json:"answer,omitempty"`
	// Output only. The model's estimate of the probability that its answer is
	// correct and grounded in the input passages.
	//
	// A low answerable_probability indicates that the answer might not be
	// grounded in the sources.
	//
	// When `answerable_probability` is low, some clients may wish to:
	//
	// * Display a message to the effect of "We couldn’t answer that question" to
	// the user.
	// * Fall back to a general-purpose LLM that answers the question from world
	// knowledge. The threshold and nature of such fallbacks will depend on
	// individual clients’ use cases. 0.5 is a good starting threshold.
	AnswerableProbability *float32 `` /* 132-byte string literal not displayed */
	// Output only. Feedback related to the input data used to answer the
	// question, as opposed to model-generated response to the question.
	//
	// "Input data" can be one or more of the following:
	//
	// - Question specified by the last entry in `GenerateAnswerRequest.content`
	// - Conversation history specified by the other entries in
	// `GenerateAnswerRequest.content`
	// - Grounding sources (`GenerateAnswerRequest.semantic_retriever` or
	// `GenerateAnswerRequest.inline_passages`)
	InputFeedback *GenerateAnswerResponse_InputFeedback `protobuf:"bytes,3,opt,name=input_feedback,json=inputFeedback,proto3,oneof" json:"input_feedback,omitempty"`
	// contains filtered or unexported fields
}

Response from the model for a grounded answer.

func (*GenerateAnswerResponse) Descriptor deprecated 

func (*GenerateAnswerResponse) Descriptor() ([]byte, []int)

Deprecated: Use GenerateAnswerResponse.ProtoReflect.Descriptor instead.

func (*GenerateAnswerResponse) GetAnswer 

func (x *GenerateAnswerResponse) GetAnswer() *Candidate

func (*GenerateAnswerResponse) GetAnswerableProbability 

func (x *GenerateAnswerResponse) GetAnswerableProbability() float32

func (*GenerateAnswerResponse) GetInputFeedback 

func (x *GenerateAnswerResponse) GetInputFeedback() *GenerateAnswerResponse_InputFeedback

func (*GenerateAnswerResponse) ProtoMessage 

func (*GenerateAnswerResponse) ProtoMessage()

func (*GenerateAnswerResponse) ProtoReflect 

func (x *GenerateAnswerResponse) ProtoReflect() protoreflect.Message

func (*GenerateAnswerResponse) Reset 

func (x *GenerateAnswerResponse) Reset()

func (*GenerateAnswerResponse) String 

func (x *GenerateAnswerResponse) String() string

type GenerateAnswerResponse_InputFeedback 

type GenerateAnswerResponse_InputFeedback struct {

	// Optional. If set, the input was blocked and no candidates are returned.
	// Rephrase your input.
	BlockReason *GenerateAnswerResponse_InputFeedback_BlockReason `` /* 191-byte string literal not displayed */
	// Ratings for safety of the input.
	// There is at most one rating per category.
	SafetyRatings []*SafetyRating `protobuf:"bytes,2,rep,name=safety_ratings,json=safetyRatings,proto3" json:"safety_ratings,omitempty"`
	// contains filtered or unexported fields
}

Feedback related to the input data used to answer the question, as opposed to model-generated response to the question.

func (*GenerateAnswerResponse_InputFeedback) Descriptor deprecated 

func (*GenerateAnswerResponse_InputFeedback) Descriptor() ([]byte, []int)

Deprecated: Use GenerateAnswerResponse_InputFeedback.ProtoReflect.Descriptor instead.

func (*GenerateAnswerResponse_InputFeedback) GetBlockReason 

func (x *GenerateAnswerResponse_InputFeedback) GetBlockReason() GenerateAnswerResponse_InputFeedback_BlockReason

func (*GenerateAnswerResponse_InputFeedback) GetSafetyRatings 

func (x *GenerateAnswerResponse_InputFeedback) GetSafetyRatings() []*SafetyRating

func (*GenerateAnswerResponse_InputFeedback) ProtoMessage 

func (*GenerateAnswerResponse_InputFeedback) ProtoMessage()

func (*GenerateAnswerResponse_InputFeedback) ProtoReflect 

func (x *GenerateAnswerResponse_InputFeedback) ProtoReflect() protoreflect.Message

func (*GenerateAnswerResponse_InputFeedback) Reset 

func (x *GenerateAnswerResponse_InputFeedback) Reset()

func (*GenerateAnswerResponse_InputFeedback) String 

func (x *GenerateAnswerResponse_InputFeedback) String() string

type GenerateAnswerResponse_InputFeedback_BlockReason 

type GenerateAnswerResponse_InputFeedback_BlockReason int32

Specifies what was the reason why input was blocked. 

const (
	// Default value. This value is unused.
	GenerateAnswerResponse_InputFeedback_BLOCK_REASON_UNSPECIFIED GenerateAnswerResponse_InputFeedback_BlockReason = 0
	// Input was blocked due to safety reasons. You can inspect
	// `safety_ratings` to understand which safety category blocked it.
	GenerateAnswerResponse_InputFeedback_SAFETY GenerateAnswerResponse_InputFeedback_BlockReason = 1
	// Input was blocked due to other reasons.
	GenerateAnswerResponse_InputFeedback_OTHER GenerateAnswerResponse_InputFeedback_BlockReason = 2
)

func (GenerateAnswerResponse_InputFeedback_BlockReason) Descriptor 

func (GenerateAnswerResponse_InputFeedback_BlockReason) Descriptor() protoreflect.EnumDescriptor

func (GenerateAnswerResponse_InputFeedback_BlockReason) Enum 

func (x GenerateAnswerResponse_InputFeedback_BlockReason) Enum() *GenerateAnswerResponse_InputFeedback_BlockReason

func (GenerateAnswerResponse_InputFeedback_BlockReason) EnumDescriptor deprecated 

func (GenerateAnswerResponse_InputFeedback_BlockReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use GenerateAnswerResponse_InputFeedback_BlockReason.Descriptor instead.

func (GenerateAnswerResponse_InputFeedback_BlockReason) Number 

func (x GenerateAnswerResponse_InputFeedback_BlockReason) Number() protoreflect.EnumNumber

func (GenerateAnswerResponse_InputFeedback_BlockReason) String 

func (x GenerateAnswerResponse_InputFeedback_BlockReason) String() string

func (GenerateAnswerResponse_InputFeedback_BlockReason) Type 

func (GenerateAnswerResponse_InputFeedback_BlockReason) Type() protoreflect.EnumType

type GenerateContentRequest 

type GenerateContentRequest struct {

	// Required. The name of the `Model` to use for generating the completion.
	//
	// Format: `name=models/{model}`.
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Optional. Developer set system instruction. Currently, text only.
	SystemInstruction *Content `protobuf:"bytes,8,opt,name=system_instruction,json=systemInstruction,proto3,oneof" json:"system_instruction,omitempty"`
	// 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.
	Contents []*Content `protobuf:"bytes,2,rep,name=contents,proto3" json:"contents,omitempty"`
	// Optional. A list of `Tools` the model may use to generate the next
	// 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. The only supported tool is currently
	// `Function`.
	Tools []*Tool `protobuf:"bytes,5,rep,name=tools,proto3" json:"tools,omitempty"`
	// Optional. Tool configuration for any `Tool` specified in the request.
	ToolConfig *ToolConfig `protobuf:"bytes,7,opt,name=tool_config,json=toolConfig,proto3" json:"tool_config,omitempty"`
	// Optional. A list of unique `SafetySetting` instances for blocking unsafe
	// content.
	//
	// This will be enforced on the `GenerateContentRequest.contents` and
	// `GenerateContentResponse.candidates`. There should not be more than one
	// setting for each `SafetyCategory` type. The API will block any contents and
	// responses that fail to meet the thresholds set by these settings. This list
	// overrides the default settings for each `SafetyCategory` specified in the
	// safety_settings. If there is no `SafetySetting` for a given
	// `SafetyCategory` provided in the list, the API will use the default safety
	// setting for that category. Harm categories HARM_CATEGORY_HATE_SPEECH,
	// HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT,
	// HARM_CATEGORY_HARASSMENT are supported.
	SafetySettings []*SafetySetting `protobuf:"bytes,3,rep,name=safety_settings,json=safetySettings,proto3" json:"safety_settings,omitempty"`
	// Optional. Configuration options for model generation and outputs.
	GenerationConfig *GenerationConfig `protobuf:"bytes,4,opt,name=generation_config,json=generationConfig,proto3,oneof" json:"generation_config,omitempty"`
	// contains filtered or unexported fields
}

Request to generate a completion from the model.

func (*GenerateContentRequest) Descriptor deprecated 

func (*GenerateContentRequest) Descriptor() ([]byte, []int)

Deprecated: Use GenerateContentRequest.ProtoReflect.Descriptor instead.

func (*GenerateContentRequest) GetContents 

func (x *GenerateContentRequest) GetContents() []*Content

func (*GenerateContentRequest) GetGenerationConfig 

func (x *GenerateContentRequest) GetGenerationConfig() *GenerationConfig

func (*GenerateContentRequest) GetModel 

func (x *GenerateContentRequest) GetModel() string

func (*GenerateContentRequest) GetSafetySettings 

func (x *GenerateContentRequest) GetSafetySettings() []*SafetySetting

func (*GenerateContentRequest) GetSystemInstruction 

func (x *GenerateContentRequest) GetSystemInstruction() *Content

func (*GenerateContentRequest) GetToolConfig 

func (x *GenerateContentRequest) GetToolConfig() *ToolConfig

func (*GenerateContentRequest) GetTools 

func (x *GenerateContentRequest) GetTools() []*Tool

func (*GenerateContentRequest) ProtoMessage 

func (*GenerateContentRequest) ProtoMessage()

func (*GenerateContentRequest) ProtoReflect 

func (x *GenerateContentRequest) ProtoReflect() protoreflect.Message

func (*GenerateContentRequest) Reset 

func (x *GenerateContentRequest) Reset()

func (*GenerateContentRequest) String 

func (x *GenerateContentRequest) String() string

type GenerateContentResponse 

type GenerateContentResponse struct {

	// Candidate responses from the model.
	Candidates []*Candidate `protobuf:"bytes,1,rep,name=candidates,proto3" json:"candidates,omitempty"`
	// Returns the prompt's feedback related to the content filters.
	PromptFeedback *GenerateContentResponse_PromptFeedback `protobuf:"bytes,2,opt,name=prompt_feedback,json=promptFeedback,proto3" json:"prompt_feedback,omitempty"`
	// contains filtered or unexported fields
}

Response from the model supporting multiple candidates.

Note on safety ratings and content filtering. They are reported for both prompt in `GenerateContentResponse.prompt_feedback` and for each candidate in `finish_reason` and in `safety_ratings`. The API contract is that:

  • either all requested candidates are returned or no candidates at all
  • no candidates are returned only if there was something wrong with the prompt (see `prompt_feedback`)
  • feedback on each candidate is reported on `finish_reason` and `safety_ratings`.

func (*GenerateContentResponse) Descriptor deprecated 

func (*GenerateContentResponse) Descriptor() ([]byte, []int)

Deprecated: Use GenerateContentResponse.ProtoReflect.Descriptor instead.

func (*GenerateContentResponse) GetCandidates 

func (x *GenerateContentResponse) GetCandidates() []*Candidate

func (*GenerateContentResponse) GetPromptFeedback 

func (x *GenerateContentResponse) GetPromptFeedback() *GenerateContentResponse_PromptFeedback

func (*GenerateContentResponse) ProtoMessage 

func (*GenerateContentResponse) ProtoMessage()

func (*GenerateContentResponse) ProtoReflect 

func (x *GenerateContentResponse) ProtoReflect() protoreflect.Message

func (*GenerateContentResponse) Reset 

func (x *GenerateContentResponse) Reset()

func (*GenerateContentResponse) String 

func (x *GenerateContentResponse) String() string

type GenerateContentResponse_PromptFeedback 

type GenerateContentResponse_PromptFeedback struct {

	// Optional. If set, the prompt was blocked and no candidates are returned.
	// Rephrase your prompt.
	BlockReason GenerateContentResponse_PromptFeedback_BlockReason `` /* 187-byte string literal not displayed */
	// Ratings for safety of the prompt.
	// There is at most one rating per category.
	SafetyRatings []*SafetyRating `protobuf:"bytes,2,rep,name=safety_ratings,json=safetyRatings,proto3" json:"safety_ratings,omitempty"`
	// contains filtered or unexported fields
}

A set of the feedback metadata the prompt specified in `GenerateContentRequest.content`.

func (*GenerateContentResponse_PromptFeedback) Descriptor deprecated 

func (*GenerateContentResponse_PromptFeedback) Descriptor() ([]byte, []int)

Deprecated: Use GenerateContentResponse_PromptFeedback.ProtoReflect.Descriptor instead.

func (*GenerateContentResponse_PromptFeedback) GetBlockReason 

func (x *GenerateContentResponse_PromptFeedback) GetBlockReason() GenerateContentResponse_PromptFeedback_BlockReason

func (*GenerateContentResponse_PromptFeedback) GetSafetyRatings 

func (x *GenerateContentResponse_PromptFeedback) GetSafetyRatings() []*SafetyRating

func (*GenerateContentResponse_PromptFeedback) ProtoMessage 

func (*GenerateContentResponse_PromptFeedback) ProtoMessage()

func (*GenerateContentResponse_PromptFeedback) ProtoReflect 

func (x *GenerateContentResponse_PromptFeedback) ProtoReflect() protoreflect.Message

func (*GenerateContentResponse_PromptFeedback) Reset 

func (x *GenerateContentResponse_PromptFeedback) Reset()

func (*GenerateContentResponse_PromptFeedback) String 

func (x *GenerateContentResponse_PromptFeedback) String() string

type GenerateContentResponse_PromptFeedback_BlockReason 

type GenerateContentResponse_PromptFeedback_BlockReason int32

Specifies what was the reason why prompt was blocked. 

const (
	// Default value. This value is unused.
	GenerateContentResponse_PromptFeedback_BLOCK_REASON_UNSPECIFIED GenerateContentResponse_PromptFeedback_BlockReason = 0
	// Prompt was blocked due to safety reasons. You can inspect
	// `safety_ratings` to understand which safety category blocked it.
	GenerateContentResponse_PromptFeedback_SAFETY GenerateContentResponse_PromptFeedback_BlockReason = 1
	// Prompt was blocked due to unknown reaasons.
	GenerateContentResponse_PromptFeedback_OTHER GenerateContentResponse_PromptFeedback_BlockReason = 2
)

func (GenerateContentResponse_PromptFeedback_BlockReason) Descriptor 

func (GenerateContentResponse_PromptFeedback_BlockReason) Descriptor() protoreflect.EnumDescriptor

func (GenerateContentResponse_PromptFeedback_BlockReason) Enum 

func (x GenerateContentResponse_PromptFeedback_BlockReason) Enum() *GenerateContentResponse_PromptFeedback_BlockReason

func (GenerateContentResponse_PromptFeedback_BlockReason) EnumDescriptor deprecated 

func (GenerateContentResponse_PromptFeedback_BlockReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use GenerateContentResponse_PromptFeedback_BlockReason.Descriptor instead.

func (GenerateContentResponse_PromptFeedback_BlockReason) Number 

func (x GenerateContentResponse_PromptFeedback_BlockReason) Number() protoreflect.EnumNumber

func (GenerateContentResponse_PromptFeedback_BlockReason) String 

func (x GenerateContentResponse_PromptFeedback_BlockReason) String() string

func (GenerateContentResponse_PromptFeedback_BlockReason) Type 

func (GenerateContentResponse_PromptFeedback_BlockReason) Type() protoreflect.EnumType

type GenerateMessageRequest 

type GenerateMessageRequest struct {

	// Required. The name of the model to use.
	//
	// Format: `name=models/{model}`.
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Required. The structured textual input given to the model as a prompt.
	//
	// Given a
	// prompt, the model will return what it predicts is the next message in the
	// discussion.
	Prompt *MessagePrompt `protobuf:"bytes,2,opt,name=prompt,proto3" json:"prompt,omitempty"`
	// Optional. Controls the randomness of the output.
	//
	// Values can range over `[0.0,1.0]`,
	// inclusive. A value closer to `1.0` will produce responses that are more
	// varied, while a value closer to `0.0` will typically result in
	// less surprising responses from the model.
	Temperature *float32 `protobuf:"fixed32,3,opt,name=temperature,proto3,oneof" json:"temperature,omitempty"`
	// Optional. The number of generated response messages to return.
	//
	// This value must be between
	// `[1, 8]`, inclusive. If unset, this will default to `1`.
	CandidateCount *int32 `protobuf:"varint,4,opt,name=candidate_count,json=candidateCount,proto3,oneof" json:"candidate_count,omitempty"`
	// Optional. The maximum cumulative probability of tokens to consider when
	// sampling.
	//
	// The model uses combined Top-k and nucleus sampling.
	//
	// Nucleus sampling considers the smallest set of tokens whose probability
	// sum is at least `top_p`.
	TopP *float32 `protobuf:"fixed32,5,opt,name=top_p,json=topP,proto3,oneof" json:"top_p,omitempty"`
	// Optional. The maximum number of tokens to consider when sampling.
	//
	// The model uses combined Top-k and nucleus sampling.
	//
	// Top-k sampling considers the set of `top_k` most probable tokens.
	TopK *int32 `protobuf:"varint,6,opt,name=top_k,json=topK,proto3,oneof" json:"top_k,omitempty"`
	// contains filtered or unexported fields
}

Request to generate a message response from the model.

func (*GenerateMessageRequest) Descriptor deprecated 

func (*GenerateMessageRequest) Descriptor() ([]byte, []int)

Deprecated: Use GenerateMessageRequest.ProtoReflect.Descriptor instead.

func (*GenerateMessageRequest) GetCandidateCount 

func (x *GenerateMessageRequest) GetCandidateCount() int32

func (*GenerateMessageRequest) GetModel 

func (x *GenerateMessageRequest) GetModel() string

func (*GenerateMessageRequest) GetPrompt 

func (x *GenerateMessageRequest) GetPrompt() *MessagePrompt

func (*GenerateMessageRequest) GetTemperature 

func (x *GenerateMessageRequest) GetTemperature() float32

func (*GenerateMessageRequest) GetTopK 

func (x *GenerateMessageRequest) GetTopK() int32

func (*GenerateMessageRequest) GetTopP 

func (x *GenerateMessageRequest) GetTopP() float32

func (*GenerateMessageRequest) ProtoMessage 

func (*GenerateMessageRequest) ProtoMessage()

func (*GenerateMessageRequest) ProtoReflect 

func (x *GenerateMessageRequest) ProtoReflect() protoreflect.Message

func (*GenerateMessageRequest) Reset 

func (x *GenerateMessageRequest) Reset()

func (*GenerateMessageRequest) String 

func (x *GenerateMessageRequest) String() string

type GenerateMessageResponse 

type GenerateMessageResponse struct {

	// Candidate response messages from the model.
	Candidates []*Message `protobuf:"bytes,1,rep,name=candidates,proto3" json:"candidates,omitempty"`
	// The conversation history used by the model.
	Messages []*Message `protobuf:"bytes,2,rep,name=messages,proto3" json:"messages,omitempty"`
	// A set of content filtering metadata for the prompt and response
	// text.
	//
	// This indicates which `SafetyCategory`(s) blocked a
	// candidate from this response, the lowest `HarmProbability`
	// that triggered a block, and the HarmThreshold setting for that category.
	Filters []*ContentFilter `protobuf:"bytes,3,rep,name=filters,proto3" json:"filters,omitempty"`
	// contains filtered or unexported fields
}

The response from the model.

This includes candidate messages and conversation history in the form of chronologically-ordered messages.

func (*GenerateMessageResponse) Descriptor deprecated 

func (*GenerateMessageResponse) Descriptor() ([]byte, []int)

Deprecated: Use GenerateMessageResponse.ProtoReflect.Descriptor instead.

func (*GenerateMessageResponse) GetCandidates 

func (x *GenerateMessageResponse) GetCandidates() []*Message

func (*GenerateMessageResponse) GetFilters 

func (x *GenerateMessageResponse) GetFilters() []*ContentFilter

func (*GenerateMessageResponse) GetMessages 

func (x *GenerateMessageResponse) GetMessages() []*Message

func (*GenerateMessageResponse) ProtoMessage 

func (*GenerateMessageResponse) ProtoMessage()

func (*GenerateMessageResponse) ProtoReflect 

func (x *GenerateMessageResponse) ProtoReflect() protoreflect.Message

func (*GenerateMessageResponse) Reset 

func (x *GenerateMessageResponse) Reset()

func (*GenerateMessageResponse) String 

func (x *GenerateMessageResponse) String() string

type GenerateTextRequest 

type GenerateTextRequest struct {

	// Required. The name of the `Model` or `TunedModel` to use for generating the
	// completion.
	// Examples:
	//
	//	models/text-bison-001
	//	tunedModels/sentence-translator-u3b7m
	Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"`
	// Required. The free-form input text given to the model as a prompt.
	//
	// Given a prompt, the model will generate a TextCompletion response it
	// predicts as the completion of the input text.
	Prompt *TextPrompt `protobuf:"bytes,2,opt,name=prompt,proto3" json:"prompt,omitempty"`
	// Optional. Controls the randomness of the output.
	// Note: The default value varies by model, see the `Model.temperature`
	// attribute of the `Model` returned the `getModel` function.
	//
	// Values can range from [0.0,1.0],
	// inclusive. A value closer to 1.0 will produce responses that are more
	// varied and creative, while a value closer to 0.0 will typically result in
	// more straightforward responses from the model.
	Temperature *float32 `protobuf:"fixed32,3,opt,name=temperature,proto3,oneof" json:"temperature,omitempty"`
	// Optional. Number of generated responses to return.
	//
	// This value must be between [1, 8], inclusive. If unset, this will default
	// to 1.
	CandidateCount *int32 `protobuf:"varint,4,opt,name=candidate_count,json=candidateCount,proto3,oneof" json:"candidate_count,omitempty"`
	// Optional. The maximum number of tokens to include in a candidate.
	//
	// If unset, this will default to output_token_limit specified in the `Model`
	// specification.
	MaxOutputTokens *int32 `protobuf:"varint,5,opt,name=max_output_tokens,json=maxOutputTokens,proto3,oneof" json:"max_output_tokens,omitempty"`
	// Optional. The maximum cumulative probability of tokens to consider when
	// sampling.
	//
	// The model uses combined Top-k and nucleus sampling.
	//
	// Tokens are sorted based on their assigned probabilities so that only the
	// most likely tokens are considered. Top-k sampling directly limits the
	// maximum number of tokens to consider, while Nucleus sampling limits number
	// of tokens based on the cumulative probability.
	//
	// Note: The default value varies by model, see the `Model.top_p`
	// attribute of the `Model` returned the `getModel` function.
	TopP *float32 `protobuf:"fixed32,6,opt,name=top_p,json=topP,proto3,oneof" json:"top_p,omitempty"`
	// Optional. The maximum number of tokens to consider when sampling.
	//
	// The model uses combined Top-k and nucleus sampling.
	//
	// Top-k sampling considers the set of `top_k` most probable tokens.
	// Defaults to 40.
	//
	// Note: The default value varies by model, see the `Model.top_k`
	// attribute of the `Model` returned the `getModel` function.
	TopK *int32 `protobuf:"varint,7,opt,name=top_k,json=topK,proto3,oneof" json:"top_k,omitempty"`
	// Optional. A list of unique `SafetySetting` instances for blocking unsafe
	// content.
	//
	// that will be enforced on the `GenerateTextRequest.prompt` and
	// `GenerateTextResponse.candidates`. There should not be more than one
	// setting for each `SafetyCategory` type. The API will block any prompts and
	// responses that fail to meet the thresholds set by these settings. This list
	// overrides the default settings for each `SafetyCategory` specified in the
	// safety_settings. If there is no `SafetySetting` for a given
	// `SafetyCategory` provided in the list, the API will use the default safety
	// setting for that category. Harm categories HARM_CATEGORY_DEROGATORY,
	// HARM_CATEGORY_TOXICITY, HARM_CATEGORY_VIOLENCE, HARM_CATEGORY_SEXUAL,
	// HARM_CATEGORY_MEDICAL, HARM_CATEGORY_DANGEROUS are supported in text
	// service.
	SafetySettings []*SafetySetting `protobuf:"bytes,8,rep,name=safety_settings,json=safetySettings,proto3" json:"safety_settings,omitempty"`
	// The set of character sequences (up to 5) that will stop output generation.
	// If specified, the API will stop at the first appearance of a stop
	// sequence. The stop sequence will not be included as part of the response.
	StopSequences []string `protobuf:"bytes,9,rep,name=stop_sequences,json=stopSequences,proto3" json:"stop_sequences,omitempty"`
	// contains filtered or unexported fields
}

Request to generate a text completion response from the model.

func (*GenerateTextRequest) Descriptor deprecated 

func (*GenerateTextRequest) Descriptor() ([]byte, []int)

Deprecated: Use GenerateTextRequest.ProtoReflect.Descriptor instead.

func (*GenerateTextRequest) GetCandidateCount 

func (x *GenerateTextRequest) GetCandidateCount() int32

func (*GenerateTextRequest) GetMaxOutputTokens 

func (x *GenerateTextRequest) GetMaxOutputTokens() int32

func (*GenerateTextRequest) GetModel 

func (x *GenerateTextRequest) GetModel() string

func (*GenerateTextRequest) GetPrompt 

func (x *GenerateTextRequest) GetPrompt() *TextPrompt

func (*GenerateTextRequest) GetSafetySettings 

func (x *GenerateTextRequest) GetSafetySettings() []*SafetySetting

func (*GenerateTextRequest) GetStopSequences 

func (x *GenerateTextRequest) GetStopSequences() []string

func (*GenerateTextRequest) GetTemperature 

func (x *GenerateTextRequest) GetTemperature() float32

func (*GenerateTextRequest) GetTopK 

func (x *GenerateTextRequest) GetTopK() int32

func (*GenerateTextRequest) GetTopP 

func (x *GenerateTextRequest) GetTopP() float32

func (*GenerateTextRequest) ProtoMessage 

func (*GenerateTextRequest) ProtoMessage()

func (*GenerateTextRequest) ProtoReflect 

func (x *GenerateTextRequest) ProtoReflect() protoreflect.Message

func (*GenerateTextRequest) Reset 

func (x *GenerateTextRequest) Reset()

func (*GenerateTextRequest) String 

func (x *GenerateTextRequest) String() string

type GenerateTextResponse 

type GenerateTextResponse struct {

	// Candidate responses from the model.
	Candidates []*TextCompletion `protobuf:"bytes,1,rep,name=candidates,proto3" json:"candidates,omitempty"`
	// A set of content filtering metadata for the prompt and response
	// text.
	//
	// This indicates which `SafetyCategory`(s) blocked a
	// candidate from this response, the lowest `HarmProbability`
	// that triggered a block, and the HarmThreshold setting for that category.
	// This indicates the smallest change to the `SafetySettings` that would be
	// necessary to unblock at least 1 response.
	//
	// The blocking is configured by the `SafetySettings` in the request (or the
	// default `SafetySettings` of the API).
	Filters []*ContentFilter `protobuf:"bytes,3,rep,name=filters,proto3" json:"filters,omitempty"`
	// Returns any safety feedback related to content filtering.
	SafetyFeedback []*SafetyFeedback `protobuf:"bytes,4,rep,name=safety_feedback,json=safetyFeedback,proto3" json:"safety_feedback,omitempty"`
	// contains filtered or unexported fields
}

The response from the model, including candidate completions.

func (*GenerateTextResponse) Descriptor deprecated 

func (*GenerateTextResponse) Descriptor() ([]byte, []int)

Deprecated: Use GenerateTextResponse.ProtoReflect.Descriptor instead.

func (*GenerateTextResponse) GetCandidates 

func (x *GenerateTextResponse) GetCandidates() []*TextCompletion

func (*GenerateTextResponse) GetFilters 

func (x *GenerateTextResponse) GetFilters() []*ContentFilter

func (*GenerateTextResponse) GetSafetyFeedback 

func (x *GenerateTextResponse) GetSafetyFeedback() []*SafetyFeedback

func (*GenerateTextResponse) ProtoMessage 

func (*GenerateTextResponse) ProtoMessage()

func (*GenerateTextResponse) ProtoReflect 

func (x *GenerateTextResponse) ProtoReflect() protoreflect.Message

func (*GenerateTextResponse) Reset 

func (x *GenerateTextResponse) Reset()

func (*GenerateTextResponse) String 

func (x *GenerateTextResponse) String() string

type GenerationConfig 

type GenerationConfig struct {

	// Optional. Number of generated responses to return.
	//
	// Currently, this value can only be set to 1. If unset, this will default
	// to 1.
	CandidateCount *int32 `protobuf:"varint,1,opt,name=candidate_count,json=candidateCount,proto3,oneof" json:"candidate_count,omitempty"`
	// Optional. The set of character sequences (up to 5) that will stop output
	// generation. If specified, the API will stop at the first appearance of a
	// stop sequence. The stop sequence will not be included as part of the
	// response.
	StopSequences []string `protobuf:"bytes,2,rep,name=stop_sequences,json=stopSequences,proto3" json:"stop_sequences,omitempty"`
	// Optional. The maximum number of tokens to include in a candidate.
	//
	// Note: The default value varies by model, see the `Model.output_token_limit`
	// attribute of the `Model` returned from the `getModel` function.
	MaxOutputTokens *int32 `protobuf:"varint,4,opt,name=max_output_tokens,json=maxOutputTokens,proto3,oneof" json:"max_output_tokens,omitempty"`
	// Optional. Controls the randomness of the output.
	//
	// Note: The default value varies by model, see the `Model.temperature`
	// attribute of the `Model` returned from the `getModel` function.
	//
	// Values can range from [0.0, 2.0].
	Temperature *float32 `protobuf:"fixed32,5,opt,name=temperature,proto3,oneof" json:"temperature,omitempty"`
	// Optional. The maximum cumulative probability of tokens to consider when
	// sampling.
	//
	// The model uses combined Top-k and nucleus sampling.
	//
	// Tokens are sorted based on their assigned probabilities so that only the
	// most likely tokens are considered. Top-k sampling directly limits the
	// maximum number of tokens to consider, while Nucleus sampling limits number
	// of tokens based on the cumulative probability.
	//
	// Note: The default value varies by model, see the `Model.top_p`
	// attribute of the `Model` returned from the `getModel` function.
	TopP *float32 `protobuf:"fixed32,6,opt,name=top_p,json=topP,proto3,oneof" json:"top_p,omitempty"`
	// Optional. The maximum number of tokens to consider when sampling.
	//
	// Models use nucleus sampling or combined Top-k and nucleus sampling.
	// Top-k sampling considers the set of `top_k` most probable tokens.
	// Models running with nucleus sampling don't allow top_k setting.
	//
	// Note: The default value varies by model, see the `Model.top_k`
	// attribute of the `Model` returned from the `getModel` function. Empty
	// `top_k` field in `Model` indicates the model doesn't apply top-k sampling
	// and doesn't allow setting `top_k` on requests.
	TopK *int32 `protobuf:"varint,7,opt,name=top_k,json=topK,proto3,oneof" json:"top_k,omitempty"`
	// Optional. Output response mimetype of the generated candidate text.
	// Supported mimetype:
	// `text/plain`: (default) Text output.
	// `application/json`: JSON response in the candidates.
	ResponseMimeType string `protobuf:"bytes,13,opt,name=response_mime_type,json=responseMimeType,proto3" json:"response_mime_type,omitempty"`
	// contains filtered or unexported fields
}

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

func (*GenerationConfig) Descriptor deprecated 

func (*GenerationConfig) Descriptor() ([]byte, []int)

Deprecated: Use GenerationConfig.ProtoReflect.Descriptor instead.

func (*GenerationConfig) GetCandidateCount 

func (x *GenerationConfig) GetCandidateCount() int32

func (*GenerationConfig) GetMaxOutputTokens 

func (x *GenerationConfig) GetMaxOutputTokens() int32

func (*GenerationConfig) GetResponseMimeType 

func (x *GenerationConfig) GetResponseMimeType() string

func (*GenerationConfig) GetStopSequences 

func (x *GenerationConfig) GetStopSequences() []string

func (*GenerationConfig) GetTemperature 

func (x *GenerationConfig) GetTemperature() float32

func (*GenerationConfig) GetTopK 

func (x *GenerationConfig) GetTopK() int32

func (*GenerationConfig) GetTopP 

func (x *GenerationConfig) GetTopP() float32

func (*GenerationConfig) ProtoMessage 

func (*GenerationConfig) ProtoMessage()

func (*GenerationConfig) ProtoReflect 

func (x *GenerationConfig) ProtoReflect() protoreflect.Message

func (*GenerationConfig) Reset 

func (x *GenerationConfig) Reset()

func (*GenerationConfig) String 

func (x *GenerationConfig) String() string

type GenerativeServiceClient 

type GenerativeServiceClient interface {
	// Generates a response from the model given an input
	// `GenerateContentRequest`.
	GenerateContent(ctx context.Context, in *GenerateContentRequest, opts ...grpc.CallOption) (*GenerateContentResponse, error)
	// Generates a grounded answer from the model given an input
	// `GenerateAnswerRequest`.
	GenerateAnswer(ctx context.Context, in *GenerateAnswerRequest, opts ...grpc.CallOption) (*GenerateAnswerResponse, error)
	// Generates a streamed response from the model given an input
	// `GenerateContentRequest`.
	StreamGenerateContent(ctx context.Context, in *GenerateContentRequest, opts ...grpc.CallOption) (GenerativeService_StreamGenerateContentClient, error)
	// Generates an embedding from the model given an input `Content`.
	EmbedContent(ctx context.Context, in *EmbedContentRequest, opts ...grpc.CallOption) (*EmbedContentResponse, error)
	// Generates multiple embeddings from the model given input text in a
	// synchronous call.
	BatchEmbedContents(ctx context.Context, in *BatchEmbedContentsRequest, opts ...grpc.CallOption) (*BatchEmbedContentsResponse, error)
	// Runs a model's tokenizer on input content and returns the token count.
	CountTokens(ctx context.Context, in *CountTokensRequest, opts ...grpc.CallOption) (*CountTokensResponse, error)
}

GenerativeServiceClient is the client API for GenerativeService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewGenerativeServiceClient 

func NewGenerativeServiceClient(cc grpc.ClientConnInterface) GenerativeServiceClient

type GenerativeServiceServer 

type GenerativeServiceServer interface {
	// Generates a response from the model given an input
	// `GenerateContentRequest`.
	GenerateContent(context.Context, *GenerateContentRequest) (*GenerateContentResponse, error)
	// Generates a grounded answer from the model given an input
	// `GenerateAnswerRequest`.
	GenerateAnswer(context.Context, *GenerateAnswerRequest) (*GenerateAnswerResponse, error)
	// Generates a streamed response from the model given an input
	// `GenerateContentRequest`.
	StreamGenerateContent(*GenerateContentRequest, GenerativeService_StreamGenerateContentServer) error
	// Generates an embedding from the model given an input `Content`.
	EmbedContent(context.Context, *EmbedContentRequest) (*EmbedContentResponse, error)
	// Generates multiple embeddings from the model given input text in a
	// synchronous call.
	BatchEmbedContents(context.Context, *BatchEmbedContentsRequest) (*BatchEmbedContentsResponse, error)
	// Runs a model's tokenizer on input content and returns the token count.
	CountTokens(context.Context, *CountTokensRequest) (*CountTokensResponse, error)
}

GenerativeServiceServer is the server API for GenerativeService service.

type GenerativeService_StreamGenerateContentClient 

type GenerativeService_StreamGenerateContentClient interface {
	Recv() (*GenerateContentResponse, error)
	grpc.ClientStream
}

type GenerativeService_StreamGenerateContentServer 

type GenerativeService_StreamGenerateContentServer interface {
	Send(*GenerateContentResponse) error
	grpc.ServerStream
}

type GetChunkRequest 

type GetChunkRequest struct {

	// Required. The name of the `Chunk` to retrieve.
	// Example: `corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for getting information about a specific `Chunk`.

func (*GetChunkRequest) Descriptor deprecated 

func (*GetChunkRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetChunkRequest.ProtoReflect.Descriptor instead.

func (*GetChunkRequest) GetName 

func (x *GetChunkRequest) GetName() string

func (*GetChunkRequest) ProtoMessage 

func (*GetChunkRequest) ProtoMessage()

func (*GetChunkRequest) ProtoReflect 

func (x *GetChunkRequest) ProtoReflect() protoreflect.Message

func (*GetChunkRequest) Reset 

func (x *GetChunkRequest) Reset()

func (*GetChunkRequest) String 

func (x *GetChunkRequest) String() string

type GetCorpusRequest 

type GetCorpusRequest struct {

	// Required. The name of the `Corpus`.
	// Example: `corpora/my-corpus-123`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for getting information about a specific `Corpus`.

func (*GetCorpusRequest) Descriptor deprecated 

func (*GetCorpusRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetCorpusRequest.ProtoReflect.Descriptor instead.

func (*GetCorpusRequest) GetName 

func (x *GetCorpusRequest) GetName() string

func (*GetCorpusRequest) ProtoMessage 

func (*GetCorpusRequest) ProtoMessage()

func (*GetCorpusRequest) ProtoReflect 

func (x *GetCorpusRequest) ProtoReflect() protoreflect.Message

func (*GetCorpusRequest) Reset 

func (x *GetCorpusRequest) Reset()

func (*GetCorpusRequest) String 

func (x *GetCorpusRequest) String() string

type GetDocumentRequest 

type GetDocumentRequest struct {

	// Required. The name of the `Document` to retrieve.
	// Example: `corpora/my-corpus-123/documents/the-doc-abc`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for getting information about a specific `Document`.

func (*GetDocumentRequest) Descriptor deprecated 

func (*GetDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetDocumentRequest.ProtoReflect.Descriptor instead.

func (*GetDocumentRequest) GetName 

func (x *GetDocumentRequest) GetName() string

func (*GetDocumentRequest) ProtoMessage 

func (*GetDocumentRequest) ProtoMessage()

func (*GetDocumentRequest) ProtoReflect 

func (x *GetDocumentRequest) ProtoReflect() protoreflect.Message

func (*GetDocumentRequest) Reset 

func (x *GetDocumentRequest) Reset()

func (*GetDocumentRequest) String 

func (x *GetDocumentRequest) String() string

type GetFileRequest 

type GetFileRequest struct {

	// Required. The name of the `File` to get.
	// Example: `files/abc-123`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for `GetFile`.

func (*GetFileRequest) Descriptor deprecated 

func (*GetFileRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetFileRequest.ProtoReflect.Descriptor instead.

func (*GetFileRequest) GetName 

func (x *GetFileRequest) GetName() string

func (*GetFileRequest) ProtoMessage 

func (*GetFileRequest) ProtoMessage()

func (*GetFileRequest) ProtoReflect 

func (x *GetFileRequest) ProtoReflect() protoreflect.Message

func (*GetFileRequest) Reset 

func (x *GetFileRequest) Reset()

func (*GetFileRequest) String 

func (x *GetFileRequest) String() string

type GetModelRequest 

type GetModelRequest struct {

	// Required. The resource name of the model.
	//
	// This name should match a model name returned by the `ListModels` method.
	//
	// Format: `models/{model}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for getting information about a specific Model.

func (*GetModelRequest) Descriptor deprecated 

func (*GetModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetModelRequest.ProtoReflect.Descriptor instead.

func (*GetModelRequest) GetName 

func (x *GetModelRequest) GetName() string

func (*GetModelRequest) ProtoMessage 

func (*GetModelRequest) ProtoMessage()

func (*GetModelRequest) ProtoReflect 

func (x *GetModelRequest) ProtoReflect() protoreflect.Message

func (*GetModelRequest) Reset 

func (x *GetModelRequest) Reset()

func (*GetModelRequest) String 

func (x *GetModelRequest) String() string

type GetPermissionRequest 

type GetPermissionRequest struct {

	// Required. The resource name of the permission.
	//
	// Formats:
	//
	//	`tunedModels/{tuned_model}/permissions/{permission}`
	//	`corpora/{corpus}/permissions/{permission}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for getting information about a specific `Permission`.

func (*GetPermissionRequest) Descriptor deprecated 

func (*GetPermissionRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetPermissionRequest.ProtoReflect.Descriptor instead.

func (*GetPermissionRequest) GetName 

func (x *GetPermissionRequest) GetName() string

func (*GetPermissionRequest) ProtoMessage 

func (*GetPermissionRequest) ProtoMessage()

func (*GetPermissionRequest) ProtoReflect 

func (x *GetPermissionRequest) ProtoReflect() protoreflect.Message

func (*GetPermissionRequest) Reset 

func (x *GetPermissionRequest) Reset()

func (*GetPermissionRequest) String 

func (x *GetPermissionRequest) String() string

type GetTunedModelRequest 

type GetTunedModelRequest struct {

	// Required. The resource name of the model.
	//
	// Format: `tunedModels/my-model-id`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for getting information about a specific Model.

func (*GetTunedModelRequest) Descriptor deprecated 

func (*GetTunedModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetTunedModelRequest.ProtoReflect.Descriptor instead.

func (*GetTunedModelRequest) GetName 

func (x *GetTunedModelRequest) GetName() string

func (*GetTunedModelRequest) ProtoMessage 

func (*GetTunedModelRequest) ProtoMessage()

func (*GetTunedModelRequest) ProtoReflect 

func (x *GetTunedModelRequest) ProtoReflect() protoreflect.Message

func (*GetTunedModelRequest) Reset 

func (x *GetTunedModelRequest) Reset()

func (*GetTunedModelRequest) String 

func (x *GetTunedModelRequest) String() string

type GroundingAttribution 

type GroundingAttribution struct {

	// Output only. Identifier for the source contributing to this attribution.
	SourceId *AttributionSourceId `protobuf:"bytes,3,opt,name=source_id,json=sourceId,proto3" json:"source_id,omitempty"`
	// Grounding source content that makes up this attribution.
	Content *Content `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

Attribution for a source that contributed to an answer.

func (*GroundingAttribution) Descriptor deprecated 

func (*GroundingAttribution) Descriptor() ([]byte, []int)

Deprecated: Use GroundingAttribution.ProtoReflect.Descriptor instead.

func (*GroundingAttribution) GetContent 

func (x *GroundingAttribution) GetContent() *Content

func (*GroundingAttribution) GetSourceId 

func (x *GroundingAttribution) GetSourceId() *AttributionSourceId

func (*GroundingAttribution) ProtoMessage 

func (*GroundingAttribution) ProtoMessage()

func (*GroundingAttribution) ProtoReflect 

func (x *GroundingAttribution) ProtoReflect() protoreflect.Message

func (*GroundingAttribution) Reset 

func (x *GroundingAttribution) Reset()

func (*GroundingAttribution) String 

func (x *GroundingAttribution) String() string

type GroundingPassage 

type GroundingPassage struct {

	// Identifier for the passage for attributing this passage in grounded
	// answers.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Content of the passage.
	Content *Content `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

Passage included inline with a grounding configuration.

func (*GroundingPassage) Descriptor deprecated 

func (*GroundingPassage) Descriptor() ([]byte, []int)

Deprecated: Use GroundingPassage.ProtoReflect.Descriptor instead.

func (*GroundingPassage) GetContent 

func (x *GroundingPassage) GetContent() *Content

func (*GroundingPassage) GetId 

func (x *GroundingPassage) GetId() string

func (*GroundingPassage) ProtoMessage 

func (*GroundingPassage) ProtoMessage()

func (*GroundingPassage) ProtoReflect 

func (x *GroundingPassage) ProtoReflect() protoreflect.Message

func (*GroundingPassage) Reset 

func (x *GroundingPassage) Reset()

func (*GroundingPassage) String 

func (x *GroundingPassage) String() string

type GroundingPassages 

type GroundingPassages struct {

	// List of passages.
	Passages []*GroundingPassage `protobuf:"bytes,1,rep,name=passages,proto3" json:"passages,omitempty"`
	// contains filtered or unexported fields
}

A repeated list of passages.

func (*GroundingPassages) Descriptor deprecated 

func (*GroundingPassages) Descriptor() ([]byte, []int)

Deprecated: Use GroundingPassages.ProtoReflect.Descriptor instead.

func (*GroundingPassages) GetPassages 

func (x *GroundingPassages) GetPassages() []*GroundingPassage

func (*GroundingPassages) ProtoMessage 

func (*GroundingPassages) ProtoMessage()

func (*GroundingPassages) ProtoReflect 

func (x *GroundingPassages) ProtoReflect() protoreflect.Message

func (*GroundingPassages) Reset 

func (x *GroundingPassages) Reset()

func (*GroundingPassages) String 

func (x *GroundingPassages) String() string

type HarmCategory 

type HarmCategory int32

The category of a rating.

These categories cover various kinds of harms that developers may wish to adjust. 

const (
	// Category is unspecified.
	HarmCategory_HARM_CATEGORY_UNSPECIFIED HarmCategory = 0
	// Negative or harmful comments targeting identity and/or protected attribute.
	HarmCategory_HARM_CATEGORY_DEROGATORY HarmCategory = 1
	// Content that is rude, disrespectful, or profane.
	HarmCategory_HARM_CATEGORY_TOXICITY HarmCategory = 2
	// Describes scenarios depicting violence against an individual or group, or
	// general descriptions of gore.
	HarmCategory_HARM_CATEGORY_VIOLENCE HarmCategory = 3
	// Contains references to sexual acts or other lewd content.
	HarmCategory_HARM_CATEGORY_SEXUAL HarmCategory = 4
	// Promotes unchecked medical advice.
	HarmCategory_HARM_CATEGORY_MEDICAL HarmCategory = 5
	// Dangerous content that promotes, facilitates, or encourages harmful acts.
	HarmCategory_HARM_CATEGORY_DANGEROUS HarmCategory = 6
	// Harasment content.
	HarmCategory_HARM_CATEGORY_HARASSMENT HarmCategory = 7
	// Hate speech and content.
	HarmCategory_HARM_CATEGORY_HATE_SPEECH HarmCategory = 8
	// Sexually explicit content.
	HarmCategory_HARM_CATEGORY_SEXUALLY_EXPLICIT HarmCategory = 9
	// Dangerous content.
	HarmCategory_HARM_CATEGORY_DANGEROUS_CONTENT HarmCategory = 10
)

func (HarmCategory) Descriptor 

func (HarmCategory) Descriptor() protoreflect.EnumDescriptor

func (HarmCategory) Enum 

func (x HarmCategory) Enum() *HarmCategory

func (HarmCategory) EnumDescriptor deprecated 

func (HarmCategory) EnumDescriptor() ([]byte, []int)

Deprecated: Use HarmCategory.Descriptor instead.

func (HarmCategory) Number 

func (x HarmCategory) Number() protoreflect.EnumNumber

func (HarmCategory) String 

func (x HarmCategory) String() string

func (HarmCategory) Type 

func (HarmCategory) Type() protoreflect.EnumType

type Hyperparameters 

type Hyperparameters struct {

	// Options for specifying learning rate during tuning.
	//
	// Types that are assignable to LearningRateOption:
	//
	//	*Hyperparameters_LearningRate
	//	*Hyperparameters_LearningRateMultiplier
	LearningRateOption isHyperparameters_LearningRateOption `protobuf_oneof:"learning_rate_option"`
	// Immutable. The number of training epochs. An epoch is one pass through the
	// training data. If not set, a default of 5 will be used.
	EpochCount *int32 `protobuf:"varint,14,opt,name=epoch_count,json=epochCount,proto3,oneof" json:"epoch_count,omitempty"`
	// Immutable. The batch size hyperparameter for tuning.
	// If not set, a default of 4 or 16 will be used based on the number of
	// training examples.
	BatchSize *int32 `protobuf:"varint,15,opt,name=batch_size,json=batchSize,proto3,oneof" json:"batch_size,omitempty"`
	// contains filtered or unexported fields
}

Hyperparameters controlling the tuning process. Read more at https://ai.google.dev/docs/model_tuning_guidance

func (*Hyperparameters) Descriptor deprecated 

func (*Hyperparameters) Descriptor() ([]byte, []int)

Deprecated: Use Hyperparameters.ProtoReflect.Descriptor instead.

func (*Hyperparameters) GetBatchSize 

func (x *Hyperparameters) GetBatchSize() int32

func (*Hyperparameters) GetEpochCount 

func (x *Hyperparameters) GetEpochCount() int32

func (*Hyperparameters) GetLearningRate 

func (x *Hyperparameters) GetLearningRate() float32

func (*Hyperparameters) GetLearningRateMultiplier 

func (x *Hyperparameters) GetLearningRateMultiplier() float32

func (*Hyperparameters) GetLearningRateOption 

func (m *Hyperparameters) GetLearningRateOption() isHyperparameters_LearningRateOption

func (*Hyperparameters) ProtoMessage 

func (*Hyperparameters) ProtoMessage()

func (*Hyperparameters) ProtoReflect 

func (x *Hyperparameters) ProtoReflect() protoreflect.Message

func (*Hyperparameters) Reset 

func (x *Hyperparameters) Reset()

func (*Hyperparameters) String 

func (x *Hyperparameters) String() string

type Hyperparameters_LearningRate 

type Hyperparameters_LearningRate struct {
	// Optional. Immutable. The learning rate hyperparameter for tuning.
	// If not set, a default of 0.001 or 0.0002 will be calculated based on the
	// number of training examples.
	LearningRate float32 `protobuf:"fixed32,16,opt,name=learning_rate,json=learningRate,proto3,oneof"`
}

type Hyperparameters_LearningRateMultiplier 

type Hyperparameters_LearningRateMultiplier struct {
	// Optional. Immutable. The learning rate multiplier is used to calculate a
	// final learning_rate based on the default (recommended) value. Actual
	// learning rate := learning_rate_multiplier * default learning rate Default
	// learning rate is dependent on base model and dataset size. If not set, a
	// default of 1.0 will be used.
	LearningRateMultiplier float32 `protobuf:"fixed32,17,opt,name=learning_rate_multiplier,json=learningRateMultiplier,proto3,oneof"`
}

type ListChunksRequest 

type ListChunksRequest struct {

	// Required. The name of the `Document` containing `Chunk`s.
	// Example: `corpora/my-corpus-123/documents/the-doc-abc`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of `Chunk`s to return (per page).
	// The service may return fewer `Chunk`s.
	//
	// If unspecified, at most 10 `Chunk`s will be returned.
	// The maximum size limit is 100 `Chunk`s per page.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListChunks` call.
	//
	// Provide the `next_page_token` returned in the response as an argument to
	// the next request to retrieve the next page.
	//
	// When paginating, all other parameters provided to `ListChunks`
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for listing `Chunk`s.

func (*ListChunksRequest) Descriptor deprecated 

func (*ListChunksRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListChunksRequest.ProtoReflect.Descriptor instead.

func (*ListChunksRequest) GetPageSize 

func (x *ListChunksRequest) GetPageSize() int32

func (*ListChunksRequest) GetPageToken 

func (x *ListChunksRequest) GetPageToken() string

func (*ListChunksRequest) GetParent 

func (x *ListChunksRequest) GetParent() string

func (*ListChunksRequest) ProtoMessage 

func (*ListChunksRequest) ProtoMessage()

func (*ListChunksRequest) ProtoReflect 

func (x *ListChunksRequest) ProtoReflect() protoreflect.Message

func (*ListChunksRequest) Reset 

func (x *ListChunksRequest) Reset()

func (*ListChunksRequest) String 

func (x *ListChunksRequest) String() string

type ListChunksResponse 

type ListChunksResponse struct {

	// The returned `Chunk`s.
	Chunks []*Chunk `protobuf:"bytes,1,rep,name=chunks,proto3" json:"chunks,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no more pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response from `ListChunks` containing a paginated list of `Chunk`s. The `Chunk`s are sorted by ascending `chunk.create_time`.

func (*ListChunksResponse) Descriptor deprecated 

func (*ListChunksResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListChunksResponse.ProtoReflect.Descriptor instead.

func (*ListChunksResponse) GetChunks 

func (x *ListChunksResponse) GetChunks() []*Chunk

func (*ListChunksResponse) GetNextPageToken 

func (x *ListChunksResponse) GetNextPageToken() string

func (*ListChunksResponse) ProtoMessage 

func (*ListChunksResponse) ProtoMessage()

func (*ListChunksResponse) ProtoReflect 

func (x *ListChunksResponse) ProtoReflect() protoreflect.Message

func (*ListChunksResponse) Reset 

func (x *ListChunksResponse) Reset()

func (*ListChunksResponse) String 

func (x *ListChunksResponse) String() string

type ListCorporaRequest 

type ListCorporaRequest struct {

	// Optional. The maximum number of `Corpora` to return (per page).
	// The service may return fewer `Corpora`.
	//
	// If unspecified, at most 10 `Corpora` will be returned.
	// The maximum size limit is 20 `Corpora` per page.
	PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListCorpora` call.
	//
	// Provide the `next_page_token` returned in the response as an argument to
	// the next request to retrieve the next page.
	//
	// When paginating, all other parameters provided to `ListCorpora`
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for listing `Corpora`.

func (*ListCorporaRequest) Descriptor deprecated 

func (*ListCorporaRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListCorporaRequest.ProtoReflect.Descriptor instead.

func (*ListCorporaRequest) GetPageSize 

func (x *ListCorporaRequest) GetPageSize() int32

func (*ListCorporaRequest) GetPageToken 

func (x *ListCorporaRequest) GetPageToken() string

func (*ListCorporaRequest) ProtoMessage 

func (*ListCorporaRequest) ProtoMessage()

func (*ListCorporaRequest) ProtoReflect 

func (x *ListCorporaRequest) ProtoReflect() protoreflect.Message

func (*ListCorporaRequest) Reset 

func (x *ListCorporaRequest) Reset()

func (*ListCorporaRequest) String 

func (x *ListCorporaRequest) String() string

type ListCorporaResponse 

type ListCorporaResponse struct {

	// The returned corpora.
	Corpora []*Corpus `protobuf:"bytes,1,rep,name=corpora,proto3" json:"corpora,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no more pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response from `ListCorpora` containing a paginated list of `Corpora`. The results are sorted by ascending `corpus.create_time`.

func (*ListCorporaResponse) Descriptor deprecated 

func (*ListCorporaResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListCorporaResponse.ProtoReflect.Descriptor instead.

func (*ListCorporaResponse) GetCorpora 

func (x *ListCorporaResponse) GetCorpora() []*Corpus

func (*ListCorporaResponse) GetNextPageToken 

func (x *ListCorporaResponse) GetNextPageToken() string

func (*ListCorporaResponse) ProtoMessage 

func (*ListCorporaResponse) ProtoMessage()

func (*ListCorporaResponse) ProtoReflect 

func (x *ListCorporaResponse) ProtoReflect() protoreflect.Message

func (*ListCorporaResponse) Reset 

func (x *ListCorporaResponse) Reset()

func (*ListCorporaResponse) String 

func (x *ListCorporaResponse) String() string

type ListDocumentsRequest 

type ListDocumentsRequest struct {

	// Required. The name of the `Corpus` containing `Document`s.
	// Example: `corpora/my-corpus-123`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of `Document`s to return (per page).
	// The service may return fewer `Document`s.
	//
	// If unspecified, at most 10 `Document`s will be returned.
	// The maximum size limit is 20 `Document`s per page.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListDocuments` call.
	//
	// Provide the `next_page_token` returned in the response as an argument to
	// the next request to retrieve the next page.
	//
	// When paginating, all other parameters provided to `ListDocuments`
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for listing `Document`s.

func (*ListDocumentsRequest) Descriptor deprecated 

func (*ListDocumentsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListDocumentsRequest.ProtoReflect.Descriptor instead.

func (*ListDocumentsRequest) GetPageSize 

func (x *ListDocumentsRequest) GetPageSize() int32

func (*ListDocumentsRequest) GetPageToken 

func (x *ListDocumentsRequest) GetPageToken() string

func (*ListDocumentsRequest) GetParent 

func (x *ListDocumentsRequest) GetParent() string

func (*ListDocumentsRequest) ProtoMessage 

func (*ListDocumentsRequest) ProtoMessage()

func (*ListDocumentsRequest) ProtoReflect 

func (x *ListDocumentsRequest) ProtoReflect() protoreflect.Message

func (*ListDocumentsRequest) Reset 

func (x *ListDocumentsRequest) Reset()

func (*ListDocumentsRequest) String 

func (x *ListDocumentsRequest) String() string

type ListDocumentsResponse 

type ListDocumentsResponse struct {

	// The returned `Document`s.
	Documents []*Document `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no more pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response from `ListDocuments` containing a paginated list of `Document`s. The `Document`s are sorted by ascending `document.create_time`.

func (*ListDocumentsResponse) Descriptor deprecated 

func (*ListDocumentsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListDocumentsResponse.ProtoReflect.Descriptor instead.

func (*ListDocumentsResponse) GetDocuments 

func (x *ListDocumentsResponse) GetDocuments() []*Document

func (*ListDocumentsResponse) GetNextPageToken 

func (x *ListDocumentsResponse) GetNextPageToken() string

func (*ListDocumentsResponse) ProtoMessage 

func (*ListDocumentsResponse) ProtoMessage()

func (*ListDocumentsResponse) ProtoReflect 

func (x *ListDocumentsResponse) ProtoReflect() protoreflect.Message

func (*ListDocumentsResponse) Reset 

func (x *ListDocumentsResponse) Reset()

func (*ListDocumentsResponse) String 

func (x *ListDocumentsResponse) String() string

type ListFilesRequest 

type ListFilesRequest struct {

	// Optional. Maximum number of `File`s to return per page.
	// If unspecified, defaults to 10. Maximum `page_size` is 100.
	PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token from a previous `ListFiles` call.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for `ListFiles`.

func (*ListFilesRequest) Descriptor deprecated 

func (*ListFilesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListFilesRequest.ProtoReflect.Descriptor instead.

func (*ListFilesRequest) GetPageSize 

func (x *ListFilesRequest) GetPageSize() int32

func (*ListFilesRequest) GetPageToken 

func (x *ListFilesRequest) GetPageToken() string

func (*ListFilesRequest) ProtoMessage 

func (*ListFilesRequest) ProtoMessage()

func (*ListFilesRequest) ProtoReflect 

func (x *ListFilesRequest) ProtoReflect() protoreflect.Message

func (*ListFilesRequest) Reset 

func (x *ListFilesRequest) Reset()

func (*ListFilesRequest) String 

func (x *ListFilesRequest) String() string

type ListFilesResponse 

type ListFilesResponse struct {

	// The list of `File`s.
	Files []*File `protobuf:"bytes,1,rep,name=files,proto3" json:"files,omitempty"`
	// A token that can be sent as a `page_token` into a subsequent `ListFiles`
	// call.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response for `ListFiles`.

func (*ListFilesResponse) Descriptor deprecated 

func (*ListFilesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListFilesResponse.ProtoReflect.Descriptor instead.

func (*ListFilesResponse) GetFiles 

func (x *ListFilesResponse) GetFiles() []*File

func (*ListFilesResponse) GetNextPageToken 

func (x *ListFilesResponse) GetNextPageToken() string

func (*ListFilesResponse) ProtoMessage 

func (*ListFilesResponse) ProtoMessage()

func (*ListFilesResponse) ProtoReflect 

func (x *ListFilesResponse) ProtoReflect() protoreflect.Message

func (*ListFilesResponse) Reset 

func (x *ListFilesResponse) Reset()

func (*ListFilesResponse) String 

func (x *ListFilesResponse) String() string

type ListModelsRequest 

type ListModelsRequest struct {

	// The maximum number of `Models` to return (per page).
	//
	// The service may return fewer models.
	// If unspecified, at most 50 models will be returned per page.
	// This method returns at most 1000 models per page, even if you pass a larger
	// page_size.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListModels` call.
	//
	// Provide the `page_token` returned by one request as an argument to the next
	// request to retrieve the next page.
	//
	// When paginating, all other parameters provided to `ListModels` must match
	// the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for listing all Models.

func (*ListModelsRequest) Descriptor deprecated 

func (*ListModelsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListModelsRequest.ProtoReflect.Descriptor instead.

func (*ListModelsRequest) GetPageSize 

func (x *ListModelsRequest) GetPageSize() int32

func (*ListModelsRequest) GetPageToken 

func (x *ListModelsRequest) GetPageToken() string

func (*ListModelsRequest) ProtoMessage 

func (*ListModelsRequest) ProtoMessage()

func (*ListModelsRequest) ProtoReflect 

func (x *ListModelsRequest) ProtoReflect() protoreflect.Message

func (*ListModelsRequest) Reset 

func (x *ListModelsRequest) Reset()

func (*ListModelsRequest) String 

func (x *ListModelsRequest) String() string

type ListModelsResponse 

type ListModelsResponse struct {

	// The returned Models.
	Models []*Model `protobuf:"bytes,1,rep,name=models,proto3" json:"models,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	//
	// If this field is omitted, there are no more pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response from `ListModel` containing a paginated list of Models.

func (*ListModelsResponse) Descriptor deprecated 

func (*ListModelsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListModelsResponse.ProtoReflect.Descriptor instead.

func (*ListModelsResponse) GetModels 

func (x *ListModelsResponse) GetModels() []*Model

func (*ListModelsResponse) GetNextPageToken 

func (x *ListModelsResponse) GetNextPageToken() string

func (*ListModelsResponse) ProtoMessage 

func (*ListModelsResponse) ProtoMessage()

func (*ListModelsResponse) ProtoReflect 

func (x *ListModelsResponse) ProtoReflect() protoreflect.Message

func (*ListModelsResponse) Reset 

func (x *ListModelsResponse) Reset()

func (*ListModelsResponse) String 

func (x *ListModelsResponse) String() string

type ListPermissionsRequest 

type ListPermissionsRequest struct {

	// Required. The parent resource of the permissions.
	// Formats:
	//
	//	`tunedModels/{tuned_model}`
	//	`corpora/{corpus}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of `Permission`s to return (per page).
	// The service may return fewer permissions.
	//
	// If unspecified, at most 10 permissions will be returned.
	// This method returns at most 1000 permissions per page, even if you pass
	// larger page_size.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListPermissions` call.
	//
	// Provide the `page_token` returned by one request as an argument to the
	// next request to retrieve the next page.
	//
	// When paginating, all other parameters provided to `ListPermissions`
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request for listing permissions.

func (*ListPermissionsRequest) Descriptor deprecated 

func (*ListPermissionsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListPermissionsRequest.ProtoReflect.Descriptor instead.

func (*ListPermissionsRequest) GetPageSize 

func (x *ListPermissionsRequest) GetPageSize() int32

func (*ListPermissionsRequest) GetPageToken 

func (x *ListPermissionsRequest) GetPageToken() string

func (*ListPermissionsRequest) GetParent 

func (x *ListPermissionsRequest) GetParent() string

func (*ListPermissionsRequest) ProtoMessage 

func (*ListPermissionsRequest) ProtoMessage()

func (*ListPermissionsRequest) ProtoReflect 

func (x *ListPermissionsRequest) ProtoReflect() protoreflect.Message

func (*ListPermissionsRequest) Reset 

func (x *ListPermissionsRequest) Reset()

func (*ListPermissionsRequest) String 

func (x *ListPermissionsRequest) String() string

type ListPermissionsResponse 

type ListPermissionsResponse struct {

	// Returned permissions.
	Permissions []*Permission `protobuf:"bytes,1,rep,name=permissions,proto3" json:"permissions,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	//
	// If this field is omitted, there are no more pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response from `ListPermissions` containing a paginated list of permissions.

func (*ListPermissionsResponse) Descriptor deprecated 

func (*ListPermissionsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListPermissionsResponse.ProtoReflect.Descriptor instead.

func (*ListPermissionsResponse) GetNextPageToken 

func (x *ListPermissionsResponse) GetNextPageToken() string

func (*ListPermissionsResponse) GetPermissions 

func (x *ListPermissionsResponse) GetPermissions() []*Permission

func (*ListPermissionsResponse) ProtoMessage 

func (*ListPermissionsResponse) ProtoMessage()

func (*ListPermissionsResponse) ProtoReflect 

func (x *ListPermissionsResponse) ProtoReflect() protoreflect.Message

func (*ListPermissionsResponse) Reset 

func (x *ListPermissionsResponse) Reset()

func (*ListPermissionsResponse) String 

func (x *ListPermissionsResponse) String() string

type ListTunedModelsRequest 

type ListTunedModelsRequest struct {

	// Optional. The maximum number of `TunedModels` to return (per page).
	// The service may return fewer tuned models.
	//
	// If unspecified, at most 10 tuned models will be returned.
	// This method returns at most 1000 models per page, even if you pass a larger
	// page_size.
	PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListTunedModels` call.
	//
	// Provide the `page_token` returned by one request as an argument to the next
	// request to retrieve the next page.
	//
	// When paginating, all other parameters provided to `ListTunedModels`
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A filter is a full text search over the tuned model's description
	// and display name. By default, results will not include tuned models shared
	// with everyone.
	//
	// Additional operators:
	//   - owner:me
	//   - writers:me
	//   - readers:me
	//   - readers:everyone
	//
	// Examples:
	//
	//	"owner:me" returns all tuned models to which caller has owner role
	//	"readers:me" returns all tuned models to which caller has reader role
	//	"readers:everyone" returns all tuned models that are shared with everyone
	Filter string `protobuf:"bytes,3,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request for listing TunedModels.

func (*ListTunedModelsRequest) Descriptor deprecated 

func (*ListTunedModelsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListTunedModelsRequest.ProtoReflect.Descriptor instead.

func (*ListTunedModelsRequest) GetFilter 

func (x *ListTunedModelsRequest) GetFilter() string

func (*ListTunedModelsRequest) GetPageSize 

func (x *ListTunedModelsRequest) GetPageSize() int32

func (*ListTunedModelsRequest) GetPageToken 

func (x *ListTunedModelsRequest) GetPageToken() string

func (*ListTunedModelsRequest) ProtoMessage 

func (*ListTunedModelsRequest) ProtoMessage()

func (*ListTunedModelsRequest) ProtoReflect 

func (x *ListTunedModelsRequest) ProtoReflect() protoreflect.Message

func (*ListTunedModelsRequest) Reset 

func (x *ListTunedModelsRequest) Reset()

func (*ListTunedModelsRequest) String 

func (x *ListTunedModelsRequest) String() string

type ListTunedModelsResponse 

type ListTunedModelsResponse struct {

	// The returned Models.
	TunedModels []*TunedModel `protobuf:"bytes,1,rep,name=tuned_models,json=tunedModels,proto3" json:"tuned_models,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	//
	// If this field is omitted, there are no more pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response from `ListTunedModels` containing a paginated list of Models.

func (*ListTunedModelsResponse) Descriptor deprecated 

func (*ListTunedModelsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListTunedModelsResponse.ProtoReflect.Descriptor instead.

func (*ListTunedModelsResponse) GetNextPageToken 

func (x *ListTunedModelsResponse) GetNextPageToken() string

func (*ListTunedModelsResponse) GetTunedModels 

func (x *ListTunedModelsResponse) GetTunedModels() []*TunedModel

func (*ListTunedModelsResponse) ProtoMessage 

func (*ListTunedModelsResponse) ProtoMessage()

func (*ListTunedModelsResponse) ProtoReflect 

func (x *ListTunedModelsResponse) ProtoReflect() protoreflect.Message

func (*ListTunedModelsResponse) Reset 

func (x *ListTunedModelsResponse) Reset()

func (*ListTunedModelsResponse) String 

func (x *ListTunedModelsResponse) String() string

type Message 

type Message struct {

	// Optional. The author of this Message.
	//
	// This serves as a key for tagging
	// the content of this Message when it is fed to the model as text.
	//
	// The author can be any alphanumeric string.
	Author string `protobuf:"bytes,1,opt,name=author,proto3" json:"author,omitempty"`
	// Required. The text content of the structured `Message`.
	Content string `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
	// Output only. Citation information for model-generated `content` in this
	// `Message`.
	//
	// If this `Message` was generated as output from the model, this field may be
	// populated with attribution information for any text included in the
	// `content`. This field is used only on output.
	CitationMetadata *CitationMetadata `protobuf:"bytes,3,opt,name=citation_metadata,json=citationMetadata,proto3,oneof" json:"citation_metadata,omitempty"`
	// contains filtered or unexported fields
}

The base unit of structured text.

A `Message` includes an `author` and the `content` of the `Message`.

The `author` is used to tag messages when they are fed to the model as text.

func (*Message) Descriptor deprecated 

func (*Message) Descriptor() ([]byte, []int)

Deprecated: Use Message.ProtoReflect.Descriptor instead.

func (*Message) GetAuthor 

func (x *Message) GetAuthor() string

func (*Message) GetCitationMetadata 

func (x *Message) GetCitationMetadata() *CitationMetadata

func (*Message) GetContent 

func (x *Message) GetContent() string

func (*Message) ProtoMessage 

func (*Message) ProtoMessage()

func (*Message) ProtoReflect 

func (x *Message) ProtoReflect() protoreflect.Message

func (*Message) Reset 

func (x *Message) Reset()

func (*Message) String 

func (x *Message) String() string

type MessagePrompt 

type MessagePrompt struct {

	// Optional. Text that should be provided to the model first to ground the
	// response.
	//
	// If not empty, this `context` will be given to the model first before the
	// `examples` and `messages`. When using a `context` be sure to provide it
	// with every request to maintain continuity.
	//
	// This field can be a description of your prompt to the model to help provide
	// context and guide the responses. Examples: "Translate the phrase from
	// English to French." or "Given a statement, classify the sentiment as happy,
	// sad or neutral."
	//
	// Anything included in this field will take precedence over message history
	// if the total input size exceeds the model's `input_token_limit` and the
	// input request is truncated.
	Context string `protobuf:"bytes,1,opt,name=context,proto3" json:"context,omitempty"`
	// Optional. Examples of what the model should generate.
	//
	// This includes both user input and the response that the model should
	// emulate.
	//
	// These `examples` are treated identically to conversation messages except
	// that they take precedence over the history in `messages`:
	// If the total input size exceeds the model's `input_token_limit` the input
	// will be truncated. Items will be dropped from `messages` before `examples`.
	Examples []*Example `protobuf:"bytes,2,rep,name=examples,proto3" json:"examples,omitempty"`
	// Required. A snapshot of the recent conversation history sorted
	// chronologically.
	//
	// Turns alternate between two authors.
	//
	// If the total input size exceeds the model's `input_token_limit` the input
	// will be truncated: The oldest items will be dropped from `messages`.
	Messages []*Message `protobuf:"bytes,3,rep,name=messages,proto3" json:"messages,omitempty"`
	// contains filtered or unexported fields
}

All of the structured input text passed to the model as a prompt.

A `MessagePrompt` contains a structured set of fields that provide context for the conversation, examples of user input/model output message pairs that prime the model to respond in different ways, and the conversation history or list of messages representing the alternating turns of the conversation between the user and the model.

func (*MessagePrompt) Descriptor deprecated 

func (*MessagePrompt) Descriptor() ([]byte, []int)

Deprecated: Use MessagePrompt.ProtoReflect.Descriptor instead.

func (*MessagePrompt) GetContext 

func (x *MessagePrompt) GetContext() string

func (*MessagePrompt) GetExamples 

func (x *MessagePrompt) GetExamples() []*Example

func (*MessagePrompt) GetMessages 

func (x *MessagePrompt) GetMessages() []*Message

func (*MessagePrompt) ProtoMessage 

func (*MessagePrompt) ProtoMessage()

func (*MessagePrompt) ProtoReflect 

func (x *MessagePrompt) ProtoReflect() protoreflect.Message

func (*MessagePrompt) Reset 

func (x *MessagePrompt) Reset()

func (*MessagePrompt) String 

func (x *MessagePrompt) String() string

type MetadataFilter 

type MetadataFilter struct {

	// Required. The key of the metadata to filter on.
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Required. The `Condition`s for the given key that will trigger this filter.
	// Multiple `Condition`s are joined by logical ORs.
	Conditions []*Condition `protobuf:"bytes,2,rep,name=conditions,proto3" json:"conditions,omitempty"`
	// contains filtered or unexported fields
}

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 = [{string_value = "drama", operation = EQUAL},
              {string_value = "action", operation = EQUAL}]

func (*MetadataFilter) Descriptor deprecated 

func (*MetadataFilter) Descriptor() ([]byte, []int)

Deprecated: Use MetadataFilter.ProtoReflect.Descriptor instead.

func (*MetadataFilter) GetConditions 

func (x *MetadataFilter) GetConditions() []*Condition

func (*MetadataFilter) GetKey 

func (x *MetadataFilter) GetKey() string

func (*MetadataFilter) ProtoMessage 

func (*MetadataFilter) ProtoMessage()

func (*MetadataFilter) ProtoReflect 

func (x *MetadataFilter) ProtoReflect() protoreflect.Message

func (*MetadataFilter) Reset 

func (x *MetadataFilter) Reset()

func (*MetadataFilter) String 

func (x *MetadataFilter) String() string

type Model 

type Model struct {

	// Required. The resource name of the `Model`.
	//
	// Format: `models/{model}` with a `{model}` naming convention of:
	//
	// * "{base_model_id}-{version}"
	//
	// Examples:
	//
	// * `models/chat-bison-001`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The name of the base model, pass this to the generation request.
	//
	// Examples:
	//
	// * `chat-bison`
	BaseModelId string `protobuf:"bytes,2,opt,name=base_model_id,json=baseModelId,proto3" json:"base_model_id,omitempty"`
	// Required. The version number of the model.
	//
	// This represents the major version
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// The human-readable name of the model. E.g. "Chat Bison".
	//
	// The name can be up to 128 characters long and can consist of any UTF-8
	// characters.
	DisplayName string `protobuf:"bytes,4,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// A short description of the model.
	Description string `protobuf:"bytes,5,opt,name=description,proto3" json:"description,omitempty"`
	// Maximum number of input tokens allowed for this model.
	InputTokenLimit int32 `protobuf:"varint,6,opt,name=input_token_limit,json=inputTokenLimit,proto3" json:"input_token_limit,omitempty"`
	// Maximum number of output tokens available for this model.
	OutputTokenLimit int32 `protobuf:"varint,7,opt,name=output_token_limit,json=outputTokenLimit,proto3" json:"output_token_limit,omitempty"`
	// The model's supported generation methods.
	//
	// The method names are defined as Pascal case
	// strings, such as `generateMessage` which correspond to API methods.
	SupportedGenerationMethods []string `` /* 141-byte string literal not displayed */
	// Controls the randomness of the output.
	//
	// Values can range over `[0.0,1.0]`, inclusive. A value closer to `1.0` will
	// produce responses that are more varied, while a value closer to `0.0` will
	// typically result in less surprising responses from the model.
	// This value specifies default to be used by the backend while making the
	// call to the model.
	Temperature *float32 `protobuf:"fixed32,9,opt,name=temperature,proto3,oneof" json:"temperature,omitempty"`
	// For Nucleus sampling.
	//
	// Nucleus sampling considers the smallest set of tokens whose probability
	// sum is at least `top_p`.
	// This value specifies default to be used by the backend while making the
	// call to the model.
	TopP *float32 `protobuf:"fixed32,10,opt,name=top_p,json=topP,proto3,oneof" json:"top_p,omitempty"`
	// For Top-k sampling.
	//
	// Top-k sampling considers the set of `top_k` most probable tokens.
	// This value specifies default to be used by the backend while making the
	// call to the model.
	// If empty, indicates the model doesn't use top-k sampling, and `top_k` isn't
	// allowed as a generation parameter.
	TopK *int32 `protobuf:"varint,11,opt,name=top_k,json=topK,proto3,oneof" json:"top_k,omitempty"`
	// contains filtered or unexported fields
}

Information about a Generative Language Model.

func (*Model) Descriptor deprecated 

func (*Model) Descriptor() ([]byte, []int)

Deprecated: Use Model.ProtoReflect.Descriptor instead.

func (*Model) GetBaseModelId 

func (x *Model) GetBaseModelId() string

func (*Model) GetDescription 

func (x *Model) GetDescription() string

func (*Model) GetDisplayName 

func (x *Model) GetDisplayName() string

func (*Model) GetInputTokenLimit 

func (x *Model) GetInputTokenLimit() int32

func (*Model) GetName 

func (x *Model) GetName() string

func (*Model) GetOutputTokenLimit 

func (x *Model) GetOutputTokenLimit() int32

func (*Model) GetSupportedGenerationMethods 

func (x *Model) GetSupportedGenerationMethods() []string

func (*Model) GetTemperature 

func (x *Model) GetTemperature() float32

func (*Model) GetTopK 

func (x *Model) GetTopK() int32

func (*Model) GetTopP 

func (x *Model) GetTopP() float32

func (*Model) GetVersion 

func (x *Model) GetVersion() string

func (*Model) ProtoMessage 

func (*Model) ProtoMessage()

func (*Model) ProtoReflect 

func (x *Model) ProtoReflect() protoreflect.Message

func (*Model) Reset 

func (x *Model) Reset()

func (*Model) String 

func (x *Model) String() string

type ModelServiceClient 

type ModelServiceClient interface {
	// Gets information about a specific Model.
	GetModel(ctx context.Context, in *GetModelRequest, opts ...grpc.CallOption) (*Model, error)
	// Lists models available through the API.
	ListModels(ctx context.Context, in *ListModelsRequest, opts ...grpc.CallOption) (*ListModelsResponse, error)
	// Gets information about a specific TunedModel.
	GetTunedModel(ctx context.Context, in *GetTunedModelRequest, opts ...grpc.CallOption) (*TunedModel, error)
	// Lists tuned models owned by the user.
	ListTunedModels(ctx context.Context, in *ListTunedModelsRequest, opts ...grpc.CallOption) (*ListTunedModelsResponse, error)
	// Creates a tuned model.
	// Intermediate tuning progress (if any) is accessed through the
	// [google.longrunning.Operations] service.
	//
	// Status and results can be accessed through the Operations service.
	// Example:
	//
	//	GET /v1/tunedModels/az2mb0bpw6i/operations/000-111-222
	CreateTunedModel(ctx context.Context, in *CreateTunedModelRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates a tuned model.
	UpdateTunedModel(ctx context.Context, in *UpdateTunedModelRequest, opts ...grpc.CallOption) (*TunedModel, error)
	// Deletes a tuned model.
	DeleteTunedModel(ctx context.Context, in *DeleteTunedModelRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

ModelServiceClient is the client API for ModelService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewModelServiceClient 

func NewModelServiceClient(cc grpc.ClientConnInterface) ModelServiceClient

type ModelServiceServer 

type ModelServiceServer interface {
	// Gets information about a specific Model.
	GetModel(context.Context, *GetModelRequest) (*Model, error)
	// Lists models available through the API.
	ListModels(context.Context, *ListModelsRequest) (*ListModelsResponse, error)
	// Gets information about a specific TunedModel.
	GetTunedModel(context.Context, *GetTunedModelRequest) (*TunedModel, error)
	// Lists tuned models owned by the user.
	ListTunedModels(context.Context, *ListTunedModelsRequest) (*ListTunedModelsResponse, error)
	// Creates a tuned model.
	// Intermediate tuning progress (if any) is accessed through the
	// [google.longrunning.Operations] service.
	//
	// Status and results can be accessed through the Operations service.
	// Example:
	//
	//	GET /v1/tunedModels/az2mb0bpw6i/operations/000-111-222
	CreateTunedModel(context.Context, *CreateTunedModelRequest) (*longrunningpb.Operation, error)
	// Updates a tuned model.
	UpdateTunedModel(context.Context, *UpdateTunedModelRequest) (*TunedModel, error)
	// Deletes a tuned model.
	DeleteTunedModel(context.Context, *DeleteTunedModelRequest) (*emptypb.Empty, error)
}

ModelServiceServer is the server API for ModelService service.

type Part 

type Part struct {

	// Types that are assignable to Data:
	//
	//	*Part_Text
	//	*Part_InlineData
	//	*Part_FunctionCall
	//	*Part_FunctionResponse
	//	*Part_FileData
	Data isPart_Data `protobuf_oneof:"data"`
	// contains filtered or unexported fields
}

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` can only contain one of the accepted types in `Part.data`.

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

func (*Part) Descriptor deprecated 

func (*Part) Descriptor() ([]byte, []int)

Deprecated: Use Part.ProtoReflect.Descriptor instead.

func (*Part) GetData 

func (m *Part) GetData() isPart_Data

func (*Part) GetFileData 

func (x *Part) GetFileData() *FileData

func (*Part) GetFunctionCall 

func (x *Part) GetFunctionCall() *FunctionCall

func (*Part) GetFunctionResponse 

func (x *Part) GetFunctionResponse() *FunctionResponse

func (*Part) GetInlineData 

func (x *Part) GetInlineData() *Blob

func (*Part) GetText 

func (x *Part) GetText() string

func (*Part) ProtoMessage 

func (*Part) ProtoMessage()

func (*Part) ProtoReflect 

func (x *Part) ProtoReflect() protoreflect.Message

func (*Part) Reset 

func (x *Part) Reset()

func (*Part) String 

func (x *Part) String() string

type Part_FileData 

type Part_FileData struct {
	// URI based data.
	FileData *FileData `protobuf:"bytes,6,opt,name=file_data,json=fileData,proto3,oneof"`
}

type Part_FunctionCall 

type Part_FunctionCall struct {
	// A predicted `FunctionCall` returned from the model that contains
	// a string representing the `FunctionDeclaration.name` with the
	// arguments and their values.
	FunctionCall *FunctionCall `protobuf:"bytes,4,opt,name=function_call,json=functionCall,proto3,oneof"`
}

type Part_FunctionResponse 

type Part_FunctionResponse struct {
	// The result output of a `FunctionCall` that contains a string
	// representing the `FunctionDeclaration.name` and a structured JSON
	// object containing any output from the function is used as context to
	// the model.
	FunctionResponse *FunctionResponse `protobuf:"bytes,5,opt,name=function_response,json=functionResponse,proto3,oneof"`
}

type Part_InlineData 

type Part_InlineData struct {
	// Inline media bytes.
	InlineData *Blob `protobuf:"bytes,3,opt,name=inline_data,json=inlineData,proto3,oneof"`
}

type Part_Text 

type Part_Text struct {
	// Inline text.
	Text string `protobuf:"bytes,2,opt,name=text,proto3,oneof"`
}

type Permission 

type Permission struct {

	// Output only. Identifier. The permission name. A unique name will be
	// generated on create. Examples:
	//
	//	tunedModels/{tuned_model}/permissions/{permission}
	//	corpora/{corpus}/permissions/{permission}
	//
	// Output only.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. Immutable. The type of the grantee.
	GranteeType *Permission_GranteeType `` /* 165-byte string literal not displayed */
	// Optional. Immutable. The email address of the user of group which this
	// permission refers. Field is not set when permission's grantee type is
	// EVERYONE.
	EmailAddress *string `protobuf:"bytes,3,opt,name=email_address,json=emailAddress,proto3,oneof" json:"email_address,omitempty"`
	// Required. The role granted by this permission.
	Role *Permission_Role `protobuf:"varint,4,opt,name=role,proto3,enum=google.ai.generativelanguage.v1beta.Permission_Role,oneof" json:"role,omitempty"`
	// contains filtered or unexported fields
}

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 (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

func (*Permission) Descriptor deprecated 

func (*Permission) Descriptor() ([]byte, []int)

Deprecated: Use Permission.ProtoReflect.Descriptor instead.

func (*Permission) GetEmailAddress 

func (x *Permission) GetEmailAddress() string

func (*Permission) GetGranteeType 

func (x *Permission) GetGranteeType() Permission_GranteeType

func (*Permission) GetName 

func (x *Permission) GetName() string

func (*Permission) GetRole 

func (x *Permission) GetRole() Permission_Role

func (*Permission) ProtoMessage 

func (*Permission) ProtoMessage()

func (*Permission) ProtoReflect 

func (x *Permission) ProtoReflect() protoreflect.Message

func (*Permission) Reset 

func (x *Permission) Reset()

func (*Permission) String 

func (x *Permission) String() string

type PermissionServiceClient 

type PermissionServiceClient interface {
	// Create a permission to a specific resource.
	CreatePermission(ctx context.Context, in *CreatePermissionRequest, opts ...grpc.CallOption) (*Permission, error)
	// Gets information about a specific Permission.
	GetPermission(ctx context.Context, in *GetPermissionRequest, opts ...grpc.CallOption) (*Permission, error)
	// Lists permissions for the specific resource.
	ListPermissions(ctx context.Context, in *ListPermissionsRequest, opts ...grpc.CallOption) (*ListPermissionsResponse, error)
	// Updates the permission.
	UpdatePermission(ctx context.Context, in *UpdatePermissionRequest, opts ...grpc.CallOption) (*Permission, error)
	// Deletes the permission.
	DeletePermission(ctx context.Context, in *DeletePermissionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// 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.
	TransferOwnership(ctx context.Context, in *TransferOwnershipRequest, opts ...grpc.CallOption) (*TransferOwnershipResponse, error)
}

PermissionServiceClient is the client API for PermissionService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewPermissionServiceClient 

func NewPermissionServiceClient(cc grpc.ClientConnInterface) PermissionServiceClient

type PermissionServiceServer 

type PermissionServiceServer interface {
	// Create a permission to a specific resource.
	CreatePermission(context.Context, *CreatePermissionRequest) (*Permission, error)
	// Gets information about a specific Permission.
	GetPermission(context.Context, *GetPermissionRequest) (*Permission, error)
	// Lists permissions for the specific resource.
	ListPermissions(context.Context, *ListPermissionsRequest) (*ListPermissionsResponse, error)
	// Updates the permission.
	UpdatePermission(context.Context, *UpdatePermissionRequest) (*Permission, error)
	// Deletes the permission.
	DeletePermission(context.Context, *DeletePermissionRequest) (*emptypb.Empty, error)
	// 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.
	TransferOwnership(context.Context, *TransferOwnershipRequest) (*TransferOwnershipResponse, error)
}

PermissionServiceServer is the server API for PermissionService service.

type Permission_GranteeType 

type Permission_GranteeType int32

Defines types of the grantee of this permission. 

const (
	// The default value. This value is unused.
	Permission_GRANTEE_TYPE_UNSPECIFIED Permission_GranteeType = 0
	// Represents a user. When set, you must provide email_address for the user.
	Permission_USER Permission_GranteeType = 1
	// Represents a group. When set, you must provide email_address for the
	// group.
	Permission_GROUP Permission_GranteeType = 2
	// Represents access to everyone. No extra information is required.
	Permission_EVERYONE Permission_GranteeType = 3
)

func (Permission_GranteeType) Descriptor 

func (Permission_GranteeType) Descriptor() protoreflect.EnumDescriptor

func (Permission_GranteeType) Enum 

func (x Permission_GranteeType) Enum() *Permission_GranteeType

func (Permission_GranteeType) EnumDescriptor deprecated 

func (Permission_GranteeType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Permission_GranteeType.Descriptor instead.

func (Permission_GranteeType) Number 

func (x Permission_GranteeType) Number() protoreflect.EnumNumber

func (Permission_GranteeType) String 

func (x Permission_GranteeType) String() string

func (Permission_GranteeType) Type 

func (Permission_GranteeType) Type() protoreflect.EnumType

type Permission_Role 

type Permission_Role int32

Defines the role granted by this permission. 

const (
	// The default value. This value is unused.
	Permission_ROLE_UNSPECIFIED Permission_Role = 0
	// Owner can use, update, share and delete the resource.
	Permission_OWNER Permission_Role = 1
	// Writer can use, update and share the resource.
	Permission_WRITER Permission_Role = 2
	// Reader can use the resource.
	Permission_READER Permission_Role = 3
)

func (Permission_Role) Descriptor 

func (Permission_Role) Descriptor() protoreflect.EnumDescriptor

func (Permission_Role) Enum 

func (x Permission_Role) Enum() *Permission_Role

func (Permission_Role) EnumDescriptor deprecated 

func (Permission_Role) EnumDescriptor() ([]byte, []int)

Deprecated: Use Permission_Role.Descriptor instead.

func (Permission_Role) Number 

func (x Permission_Role) Number() protoreflect.EnumNumber

func (Permission_Role) String 

func (x Permission_Role) String() string

func (Permission_Role) Type 

func (Permission_Role) Type() protoreflect.EnumType

type QueryCorpusRequest 

type QueryCorpusRequest struct {

	// Required. The name of the `Corpus` to query.
	// Example: `corpora/my-corpus-123`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Query string to perform semantic search.
	Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// Optional. Filter for `Chunk` and `Document` metadata. Each `MetadataFilter`
	// object should correspond to a unique key. Multiple `MetadataFilter` objects
	// are joined by logical "AND"s.
	//
	// Example query at document level:
	// (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)
	//
	// `MetadataFilter` object list:
	//
	//	metadata_filters = [
	//	{key = "document.custom_metadata.year"
	//	 conditions = [{int_value = 2020, operation = GREATER_EQUAL},
	//	               {int_value = 2010, operation = LESS}]},
	//	{key = "document.custom_metadata.year"
	//	 conditions = [{int_value = 2020, operation = GREATER_EQUAL},
	//	               {int_value = 2010, operation = LESS}]},
	//	{key = "document.custom_metadata.genre"
	//	 conditions = [{string_value = "drama", operation = EQUAL},
	//	               {string_value = "action", operation = EQUAL}]}]
	//
	// Example query at chunk level for a numeric range of values:
	// (year > 2015 AND year <= 2020)
	//
	// `MetadataFilter` object list:
	//
	//	metadata_filters = [
	//	{key = "chunk.custom_metadata.year"
	//	 conditions = [{int_value = 2015, operation = GREATER}]},
	//	{key = "chunk.custom_metadata.year"
	//	 conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]
	//
	// Note: "AND"s for the same key are only supported for numeric values. String
	// values only support "OR"s for the same key.
	MetadataFilters []*MetadataFilter `protobuf:"bytes,3,rep,name=metadata_filters,json=metadataFilters,proto3" json:"metadata_filters,omitempty"`
	// Optional. The maximum number of `Chunk`s to return.
	// The service may return fewer `Chunk`s.
	//
	// If unspecified, at most 10 `Chunk`s will be returned.
	// The maximum specified result count is 100.
	ResultsCount int32 `protobuf:"varint,4,opt,name=results_count,json=resultsCount,proto3" json:"results_count,omitempty"`
	// contains filtered or unexported fields
}

Request for querying a `Corpus`.

func (*QueryCorpusRequest) Descriptor deprecated 

func (*QueryCorpusRequest) Descriptor() ([]byte, []int)

Deprecated: Use QueryCorpusRequest.ProtoReflect.Descriptor instead.

func (*QueryCorpusRequest) GetMetadataFilters 

func (x *QueryCorpusRequest) GetMetadataFilters() []*MetadataFilter

func (*QueryCorpusRequest) GetName 

func (x *QueryCorpusRequest) GetName() string

func (*QueryCorpusRequest) GetQuery 

func (x *QueryCorpusRequest) GetQuery() string

func (*QueryCorpusRequest) GetResultsCount 

func (x *QueryCorpusRequest) GetResultsCount() int32

func (*QueryCorpusRequest) ProtoMessage 

func (*QueryCorpusRequest) ProtoMessage()

func (*QueryCorpusRequest) ProtoReflect 

func (x *QueryCorpusRequest) ProtoReflect() protoreflect.Message

func (*QueryCorpusRequest) Reset 

func (x *QueryCorpusRequest) Reset()

func (*QueryCorpusRequest) String 

func (x *QueryCorpusRequest) String() string

type QueryCorpusResponse 

type QueryCorpusResponse struct {

	// The relevant chunks.
	RelevantChunks []*RelevantChunk `protobuf:"bytes,1,rep,name=relevant_chunks,json=relevantChunks,proto3" json:"relevant_chunks,omitempty"`
	// contains filtered or unexported fields
}

Response from `QueryCorpus` containing a list of relevant chunks.

func (*QueryCorpusResponse) Descriptor deprecated 

func (*QueryCorpusResponse) Descriptor() ([]byte, []int)

Deprecated: Use QueryCorpusResponse.ProtoReflect.Descriptor instead.

func (*QueryCorpusResponse) GetRelevantChunks 

func (x *QueryCorpusResponse) GetRelevantChunks() []*RelevantChunk

func (*QueryCorpusResponse) ProtoMessage 

func (*QueryCorpusResponse) ProtoMessage()

func (*QueryCorpusResponse) ProtoReflect 

func (x *QueryCorpusResponse) ProtoReflect() protoreflect.Message

func (*QueryCorpusResponse) Reset 

func (x *QueryCorpusResponse) Reset()

func (*QueryCorpusResponse) String 

func (x *QueryCorpusResponse) String() string

type QueryDocumentRequest 

type QueryDocumentRequest struct {

	// Required. The name of the `Document` to query.
	// Example: `corpora/my-corpus-123/documents/the-doc-abc`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. Query string to perform semantic search.
	Query string `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// Optional. The maximum number of `Chunk`s to return.
	// The service may return fewer `Chunk`s.
	//
	// If unspecified, at most 10 `Chunk`s will be returned.
	// The maximum specified result count is 100.
	ResultsCount int32 `protobuf:"varint,3,opt,name=results_count,json=resultsCount,proto3" json:"results_count,omitempty"`
	// Optional. Filter for `Chunk` metadata. Each `MetadataFilter` object should
	// correspond to a unique key. Multiple `MetadataFilter` objects are joined by
	// logical "AND"s.
	//
	// Note: `Document`-level filtering is not supported for this request because
	// a `Document` name is already specified.
	//
	// Example query:
	// (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)
	//
	// `MetadataFilter` object list:
	//
	//	metadata_filters = [
	//	{key = "chunk.custom_metadata.year"
	//	 conditions = [{int_value = 2020, operation = GREATER_EQUAL},
	//	               {int_value = 2010, operation = LESS}},
	//	{key = "chunk.custom_metadata.genre"
	//	 conditions = [{string_value = "drama", operation = EQUAL},
	//	               {string_value = "action", operation = EQUAL}}]
	//
	// Example query for a numeric range of values:
	// (year > 2015 AND year <= 2020)
	//
	// `MetadataFilter` object list:
	//
	//	metadata_filters = [
	//	{key = "chunk.custom_metadata.year"
	//	 conditions = [{int_value = 2015, operation = GREATER}]},
	//	{key = "chunk.custom_metadata.year"
	//	 conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]
	//
	// Note: "AND"s for the same key are only supported for numeric values. String
	// values only support "OR"s for the same key.
	MetadataFilters []*MetadataFilter `protobuf:"bytes,4,rep,name=metadata_filters,json=metadataFilters,proto3" json:"metadata_filters,omitempty"`
	// contains filtered or unexported fields
}

Request for querying a `Document`.

func (*QueryDocumentRequest) Descriptor deprecated 

func (*QueryDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use QueryDocumentRequest.ProtoReflect.Descriptor instead.

func (*QueryDocumentRequest) GetMetadataFilters 

func (x *QueryDocumentRequest) GetMetadataFilters() []*MetadataFilter

func (*QueryDocumentRequest) GetName 

func (x *QueryDocumentRequest) GetName() string

func (*QueryDocumentRequest) GetQuery 

func (x *QueryDocumentRequest) GetQuery() string

func (*QueryDocumentRequest) GetResultsCount 

func (x *QueryDocumentRequest) GetResultsCount() int32

func (*QueryDocumentRequest) ProtoMessage 

func (*QueryDocumentRequest) ProtoMessage()

func (*QueryDocumentRequest) ProtoReflect 

func (x *QueryDocumentRequest) ProtoReflect() protoreflect.Message

func (*QueryDocumentRequest) Reset 

func (x *QueryDocumentRequest) Reset()

func (*QueryDocumentRequest) String 

func (x *QueryDocumentRequest) String() string

type QueryDocumentResponse 

type QueryDocumentResponse struct {

	// The returned relevant chunks.
	RelevantChunks []*RelevantChunk `protobuf:"bytes,1,rep,name=relevant_chunks,json=relevantChunks,proto3" json:"relevant_chunks,omitempty"`
	// contains filtered or unexported fields
}

Response from `QueryDocument` containing a list of relevant chunks.

func (*QueryDocumentResponse) Descriptor deprecated 

func (*QueryDocumentResponse) Descriptor() ([]byte, []int)

Deprecated: Use QueryDocumentResponse.ProtoReflect.Descriptor instead.

func (*QueryDocumentResponse) GetRelevantChunks 

func (x *QueryDocumentResponse) GetRelevantChunks() []*RelevantChunk

func (*QueryDocumentResponse) ProtoMessage 

func (*QueryDocumentResponse) ProtoMessage()

func (*QueryDocumentResponse) ProtoReflect 

func (x *QueryDocumentResponse) ProtoReflect() protoreflect.Message

func (*QueryDocumentResponse) Reset 

func (x *QueryDocumentResponse) Reset()

func (*QueryDocumentResponse) String 

func (x *QueryDocumentResponse) String() string

type RelevantChunk 

type RelevantChunk struct {

	// `Chunk` relevance to the query.
	ChunkRelevanceScore float32 `protobuf:"fixed32,1,opt,name=chunk_relevance_score,json=chunkRelevanceScore,proto3" json:"chunk_relevance_score,omitempty"`
	// `Chunk` associated with the query.
	Chunk *Chunk `protobuf:"bytes,2,opt,name=chunk,proto3" json:"chunk,omitempty"`
	// contains filtered or unexported fields
}

The information for a chunk relevant to a query.

func (*RelevantChunk) Descriptor deprecated 

func (*RelevantChunk) Descriptor() ([]byte, []int)

Deprecated: Use RelevantChunk.ProtoReflect.Descriptor instead.

func (*RelevantChunk) GetChunk 

func (x *RelevantChunk) GetChunk() *Chunk

func (*RelevantChunk) GetChunkRelevanceScore 

func (x *RelevantChunk) GetChunkRelevanceScore() float32

func (*RelevantChunk) ProtoMessage 

func (*RelevantChunk) ProtoMessage()

func (*RelevantChunk) ProtoReflect 

func (x *RelevantChunk) ProtoReflect() protoreflect.Message

func (*RelevantChunk) Reset 

func (x *RelevantChunk) Reset()

func (*RelevantChunk) String 

func (x *RelevantChunk) String() string

type RetrieverServiceClient 

type RetrieverServiceClient interface {
	// Creates an empty `Corpus`.
	CreateCorpus(ctx context.Context, in *CreateCorpusRequest, opts ...grpc.CallOption) (*Corpus, error)
	// Gets information about a specific `Corpus`.
	GetCorpus(ctx context.Context, in *GetCorpusRequest, opts ...grpc.CallOption) (*Corpus, error)
	// Updates a `Corpus`.
	UpdateCorpus(ctx context.Context, in *UpdateCorpusRequest, opts ...grpc.CallOption) (*Corpus, error)
	// Deletes a `Corpus`.
	DeleteCorpus(ctx context.Context, in *DeleteCorpusRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Lists all `Corpora` owned by the user.
	ListCorpora(ctx context.Context, in *ListCorporaRequest, opts ...grpc.CallOption) (*ListCorporaResponse, error)
	// Performs semantic search over a `Corpus`.
	QueryCorpus(ctx context.Context, in *QueryCorpusRequest, opts ...grpc.CallOption) (*QueryCorpusResponse, error)
	// Creates an empty `Document`.
	CreateDocument(ctx context.Context, in *CreateDocumentRequest, opts ...grpc.CallOption) (*Document, error)
	// Gets information about a specific `Document`.
	GetDocument(ctx context.Context, in *GetDocumentRequest, opts ...grpc.CallOption) (*Document, error)
	// Updates a `Document`.
	UpdateDocument(ctx context.Context, in *UpdateDocumentRequest, opts ...grpc.CallOption) (*Document, error)
	// Deletes a `Document`.
	DeleteDocument(ctx context.Context, in *DeleteDocumentRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Lists all `Document`s in a `Corpus`.
	ListDocuments(ctx context.Context, in *ListDocumentsRequest, opts ...grpc.CallOption) (*ListDocumentsResponse, error)
	// Performs semantic search over a `Document`.
	QueryDocument(ctx context.Context, in *QueryDocumentRequest, opts ...grpc.CallOption) (*QueryDocumentResponse, error)
	// Creates a `Chunk`.
	CreateChunk(ctx context.Context, in *CreateChunkRequest, opts ...grpc.CallOption) (*Chunk, error)
	// Batch create `Chunk`s.
	BatchCreateChunks(ctx context.Context, in *BatchCreateChunksRequest, opts ...grpc.CallOption) (*BatchCreateChunksResponse, error)
	// Gets information about a specific `Chunk`.
	GetChunk(ctx context.Context, in *GetChunkRequest, opts ...grpc.CallOption) (*Chunk, error)
	// Updates a `Chunk`.
	UpdateChunk(ctx context.Context, in *UpdateChunkRequest, opts ...grpc.CallOption) (*Chunk, error)
	// Batch update `Chunk`s.
	BatchUpdateChunks(ctx context.Context, in *BatchUpdateChunksRequest, opts ...grpc.CallOption) (*BatchUpdateChunksResponse, error)
	// Deletes a `Chunk`.
	DeleteChunk(ctx context.Context, in *DeleteChunkRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Batch delete `Chunk`s.
	BatchDeleteChunks(ctx context.Context, in *BatchDeleteChunksRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Lists all `Chunk`s in a `Document`.
	ListChunks(ctx context.Context, in *ListChunksRequest, opts ...grpc.CallOption) (*ListChunksResponse, error)
}

RetrieverServiceClient is the client API for RetrieverService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewRetrieverServiceClient 

func NewRetrieverServiceClient(cc grpc.ClientConnInterface) RetrieverServiceClient

type RetrieverServiceServer 

type RetrieverServiceServer interface {
	// Creates an empty `Corpus`.
	CreateCorpus(context.Context, *CreateCorpusRequest) (*Corpus, error)
	// Gets information about a specific `Corpus`.
	GetCorpus(context.Context, *GetCorpusRequest) (*Corpus, error)
	// Updates a `Corpus`.
	UpdateCorpus(context.Context, *UpdateCorpusRequest) (*Corpus, error)
	// Deletes a `Corpus`.
	DeleteCorpus(context.Context, *DeleteCorpusRequest) (*emptypb.Empty, error)
	// Lists all `Corpora` owned by the user.
	ListCorpora(context.Context, *ListCorporaRequest) (*ListCorporaResponse, error)
	// Performs semantic search over a `Corpus`.
	QueryCorpus(context.Context, *QueryCorpusRequest) (*QueryCorpusResponse, error)
	// Creates an empty `Document`.
	CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)
	// Gets information about a specific `Document`.
	GetDocument(context.Context, *GetDocumentRequest) (*Document, error)
	// Updates a `Document`.
	UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)
	// Deletes a `Document`.
	DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)
	// Lists all `Document`s in a `Corpus`.
	ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)
	// Performs semantic search over a `Document`.
	QueryDocument(context.Context, *QueryDocumentRequest) (*QueryDocumentResponse, error)
	// Creates a `Chunk`.
	CreateChunk(context.Context, *CreateChunkRequest) (*Chunk, error)
	// Batch create `Chunk`s.
	BatchCreateChunks(context.Context, *BatchCreateChunksRequest) (*BatchCreateChunksResponse, error)
	// Gets information about a specific `Chunk`.
	GetChunk(context.Context, *GetChunkRequest) (*Chunk, error)
	// Updates a `Chunk`.
	UpdateChunk(context.Context, *UpdateChunkRequest) (*Chunk, error)
	// Batch update `Chunk`s.
	BatchUpdateChunks(context.Context, *BatchUpdateChunksRequest) (*BatchUpdateChunksResponse, error)
	// Deletes a `Chunk`.
	DeleteChunk(context.Context, *DeleteChunkRequest) (*emptypb.Empty, error)
	// Batch delete `Chunk`s.
	BatchDeleteChunks(context.Context, *BatchDeleteChunksRequest) (*emptypb.Empty, error)
	// Lists all `Chunk`s in a `Document`.
	ListChunks(context.Context, *ListChunksRequest) (*ListChunksResponse, error)
}

RetrieverServiceServer is the server API for RetrieverService service.

type SafetyFeedback 

type SafetyFeedback struct {

	// Safety rating evaluated from content.
	Rating *SafetyRating `protobuf:"bytes,1,opt,name=rating,proto3" json:"rating,omitempty"`
	// Safety settings applied to the request.
	Setting *SafetySetting `protobuf:"bytes,2,opt,name=setting,proto3" json:"setting,omitempty"`
	// contains filtered or unexported fields
}

Safety feedback for an entire request.

This field is populated if content in the input and/or response is blocked due to safety settings. SafetyFeedback may not exist for every HarmCategory. Each SafetyFeedback will return the safety settings used by the request as well as the lowest HarmProbability that should be allowed in order to return a result.

func (*SafetyFeedback) Descriptor deprecated 

func (*SafetyFeedback) Descriptor() ([]byte, []int)

Deprecated: Use SafetyFeedback.ProtoReflect.Descriptor instead.

func (*SafetyFeedback) GetRating 

func (x *SafetyFeedback) GetRating() *SafetyRating

func (*SafetyFeedback) GetSetting 

func (x *SafetyFeedback) GetSetting() *SafetySetting

func (*SafetyFeedback) ProtoMessage 

func (*SafetyFeedback) ProtoMessage()

func (*SafetyFeedback) ProtoReflect 

func (x *SafetyFeedback) ProtoReflect() protoreflect.Message

func (*SafetyFeedback) Reset 

func (x *SafetyFeedback) Reset()

func (*SafetyFeedback) String 

func (x *SafetyFeedback) String() string

type SafetyRating 

type SafetyRating struct {

	// Required. The category for this rating.
	Category HarmCategory `protobuf:"varint,3,opt,name=category,proto3,enum=google.ai.generativelanguage.v1beta.HarmCategory" json:"category,omitempty"`
	// Required. The probability of harm for this content.
	Probability SafetyRating_HarmProbability `` /* 146-byte string literal not displayed */
	// Was this content blocked because of this rating?
	Blocked bool `protobuf:"varint,5,opt,name=blocked,proto3" json:"blocked,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*SafetyRating) Descriptor deprecated 

func (*SafetyRating) Descriptor() ([]byte, []int)

Deprecated: Use SafetyRating.ProtoReflect.Descriptor instead.

func (*SafetyRating) GetBlocked 

func (x *SafetyRating) GetBlocked() bool

func (*SafetyRating) GetCategory 

func (x *SafetyRating) GetCategory() HarmCategory

func (*SafetyRating) GetProbability 

func (x *SafetyRating) GetProbability() SafetyRating_HarmProbability

func (*SafetyRating) ProtoMessage 

func (*SafetyRating) ProtoMessage()

func (*SafetyRating) ProtoReflect 

func (x *SafetyRating) ProtoReflect() protoreflect.Message

func (*SafetyRating) Reset 

func (x *SafetyRating) Reset()

func (*SafetyRating) String 

func (x *SafetyRating) String() string

type SafetyRating_HarmProbability 

type SafetyRating_HarmProbability int32

The probability that a piece of content is harmful.

The classification system gives the probability of the content being unsafe. This does not indicate the severity of harm for a piece of content. 

const (
	// Probability is unspecified.
	SafetyRating_HARM_PROBABILITY_UNSPECIFIED SafetyRating_HarmProbability = 0
	// Content has a negligible chance of being unsafe.
	SafetyRating_NEGLIGIBLE SafetyRating_HarmProbability = 1
	// Content has a low chance of being unsafe.
	SafetyRating_LOW SafetyRating_HarmProbability = 2
	// Content has a medium chance of being unsafe.
	SafetyRating_MEDIUM SafetyRating_HarmProbability = 3
	// Content has a high chance of being unsafe.
	SafetyRating_HIGH SafetyRating_HarmProbability = 4
)

func (SafetyRating_HarmProbability) Descriptor 

func (SafetyRating_HarmProbability) Descriptor() protoreflect.EnumDescriptor

func (SafetyRating_HarmProbability) Enum 

func (x SafetyRating_HarmProbability) Enum() *SafetyRating_HarmProbability

func (SafetyRating_HarmProbability) EnumDescriptor deprecated 

func (SafetyRating_HarmProbability) EnumDescriptor() ([]byte, []int)

Deprecated: Use SafetyRating_HarmProbability.Descriptor instead.

func (SafetyRating_HarmProbability) Number 

func (x SafetyRating_HarmProbability) Number() protoreflect.EnumNumber

func (SafetyRating_HarmProbability) String 

func (x SafetyRating_HarmProbability) String() string

func (SafetyRating_HarmProbability) Type 

func (SafetyRating_HarmProbability) Type() protoreflect.EnumType

type SafetySetting 

type SafetySetting struct {

	// Required. The category for this setting.
	Category HarmCategory `protobuf:"varint,3,opt,name=category,proto3,enum=google.ai.generativelanguage.v1beta.HarmCategory" json:"category,omitempty"`
	// Required. Controls the probability threshold at which harm is blocked.
	Threshold SafetySetting_HarmBlockThreshold `` /* 146-byte string literal not displayed */
	// contains filtered or unexported fields
}

Safety setting, affecting the safety-blocking behavior.

Passing a safety setting for a category changes the allowed proability that content is blocked.

func (*SafetySetting) Descriptor deprecated 

func (*SafetySetting) Descriptor() ([]byte, []int)

Deprecated: Use SafetySetting.ProtoReflect.Descriptor instead.

func (*SafetySetting) GetCategory 

func (x *SafetySetting) GetCategory() HarmCategory

func (*SafetySetting) GetThreshold 

func (x *SafetySetting) GetThreshold() SafetySetting_HarmBlockThreshold

func (*SafetySetting) ProtoMessage 

func (*SafetySetting) ProtoMessage()

func (*SafetySetting) ProtoReflect 

func (x *SafetySetting) ProtoReflect() protoreflect.Message

func (*SafetySetting) Reset 

func (x *SafetySetting) Reset()

func (*SafetySetting) String 

func (x *SafetySetting) String() string

type SafetySetting_HarmBlockThreshold 

type SafetySetting_HarmBlockThreshold int32

Block at and beyond a specified harm probability. 

const (
	// Threshold is unspecified.
	SafetySetting_HARM_BLOCK_THRESHOLD_UNSPECIFIED SafetySetting_HarmBlockThreshold = 0
	// Content with NEGLIGIBLE will be allowed.
	SafetySetting_BLOCK_LOW_AND_ABOVE SafetySetting_HarmBlockThreshold = 1
	// Content with NEGLIGIBLE and LOW will be allowed.
	SafetySetting_BLOCK_MEDIUM_AND_ABOVE SafetySetting_HarmBlockThreshold = 2
	// Content with NEGLIGIBLE, LOW, and MEDIUM will be allowed.
	SafetySetting_BLOCK_ONLY_HIGH SafetySetting_HarmBlockThreshold = 3
	// All content will be allowed.
	SafetySetting_BLOCK_NONE SafetySetting_HarmBlockThreshold = 4
)

func (SafetySetting_HarmBlockThreshold) Descriptor 

func (SafetySetting_HarmBlockThreshold) Descriptor() protoreflect.EnumDescriptor

func (SafetySetting_HarmBlockThreshold) Enum 

func (x SafetySetting_HarmBlockThreshold) Enum() *SafetySetting_HarmBlockThreshold

func (SafetySetting_HarmBlockThreshold) EnumDescriptor deprecated 

func (SafetySetting_HarmBlockThreshold) EnumDescriptor() ([]byte, []int)

Deprecated: Use SafetySetting_HarmBlockThreshold.Descriptor instead.

func (SafetySetting_HarmBlockThreshold) Number 

func (x SafetySetting_HarmBlockThreshold) Number() protoreflect.EnumNumber

func (SafetySetting_HarmBlockThreshold) String 

func (x SafetySetting_HarmBlockThreshold) String() string

func (SafetySetting_HarmBlockThreshold) Type 

func (SafetySetting_HarmBlockThreshold) Type() protoreflect.EnumType

type Schema 

type Schema struct {

	// Required. Data type.
	Type Type `protobuf:"varint,1,opt,name=type,proto3,enum=google.ai.generativelanguage.v1beta.Type" json:"type,omitempty"`
	// Optional. The format of the data. This is used only for primitive
	// datatypes. Supported formats:
	//
	//	for NUMBER type: float, double
	//	for INTEGER type: int32, int64
	Format string `protobuf:"bytes,2,opt,name=format,proto3" json:"format,omitempty"`
	// Optional. A brief description of the parameter. This could contain examples
	// of use. Parameter description may be formatted as Markdown.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. Indicates if the value may be null.
	Nullable bool `protobuf:"varint,4,opt,name=nullable,proto3" json:"nullable,omitempty"`
	// 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"]}
	Enum []string `protobuf:"bytes,5,rep,name=enum,proto3" json:"enum,omitempty"`
	// Optional. Schema of the elements of Type.ARRAY.
	Items *Schema `protobuf:"bytes,6,opt,name=items,proto3,oneof" json:"items,omitempty"`
	// Optional. Properties of Type.OBJECT.
	Properties map[string]*Schema `` /* 161-byte string literal not displayed */
	// Optional. Required properties of Type.OBJECT.
	Required []string `protobuf:"bytes,8,rep,name=required,proto3" json:"required,omitempty"`
	// contains filtered or unexported fields
}

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).

func (*Schema) Descriptor deprecated 

func (*Schema) Descriptor() ([]byte, []int)

Deprecated: Use Schema.ProtoReflect.Descriptor instead.

func (*Schema) GetDescription 

func (x *Schema) GetDescription() string

func (*Schema) GetEnum 

func (x *Schema) GetEnum() []string

func (*Schema) GetFormat 

func (x *Schema) GetFormat() string

func (*Schema) GetItems 

func (x *Schema) GetItems() *Schema

func (*Schema) GetNullable 

func (x *Schema) GetNullable() bool

func (*Schema) GetProperties 

func (x *Schema) GetProperties() map[string]*Schema

func (*Schema) GetRequired 

func (x *Schema) GetRequired() []string

func (*Schema) GetType 

func (x *Schema) GetType() Type

func (*Schema) ProtoMessage 

func (*Schema) ProtoMessage()

func (*Schema) ProtoReflect 

func (x *Schema) ProtoReflect() protoreflect.Message

func (*Schema) Reset 

func (x *Schema) Reset()

func (*Schema) String 

func (x *Schema) String() string

type SemanticRetrieverConfig 

type SemanticRetrieverConfig struct {

	// Required. Name of the resource for retrieval, e.g. corpora/123 or
	// corpora/123/documents/abc.
	Source string `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	// Required. Query to use for similarity matching `Chunk`s in the given
	// resource.
	Query *Content `protobuf:"bytes,2,opt,name=query,proto3" json:"query,omitempty"`
	// Optional. Filters for selecting `Document`s and/or `Chunk`s from the
	// resource.
	MetadataFilters []*MetadataFilter `protobuf:"bytes,3,rep,name=metadata_filters,json=metadataFilters,proto3" json:"metadata_filters,omitempty"`
	// Optional. Maximum number of relevant `Chunk`s to retrieve.
	MaxChunksCount *int32 `protobuf:"varint,4,opt,name=max_chunks_count,json=maxChunksCount,proto3,oneof" json:"max_chunks_count,omitempty"`
	// Optional. Minimum relevance score for retrieved relevant `Chunk`s.
	MinimumRelevanceScore *float32 `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration for retrieving grounding content from a `Corpus` or `Document` created using the Semantic Retriever API.

func (*SemanticRetrieverConfig) Descriptor deprecated 

func (*SemanticRetrieverConfig) Descriptor() ([]byte, []int)

Deprecated: Use SemanticRetrieverConfig.ProtoReflect.Descriptor instead.

func (*SemanticRetrieverConfig) GetMaxChunksCount 

func (x *SemanticRetrieverConfig) GetMaxChunksCount() int32

func (*SemanticRetrieverConfig) GetMetadataFilters 

func (x *SemanticRetrieverConfig) GetMetadataFilters() []*MetadataFilter

func (*SemanticRetrieverConfig) GetMinimumRelevanceScore 

func (x *SemanticRetrieverConfig) GetMinimumRelevanceScore() float32

func (*SemanticRetrieverConfig) GetQuery 

func (x *SemanticRetrieverConfig) GetQuery() *Content

func (*SemanticRetrieverConfig) GetSource 

func (x *SemanticRetrieverConfig) GetSource() string

func (*SemanticRetrieverConfig) ProtoMessage 

func (*SemanticRetrieverConfig) ProtoMessage()

func (*SemanticRetrieverConfig) ProtoReflect 

func (x *SemanticRetrieverConfig) ProtoReflect() protoreflect.Message

func (*SemanticRetrieverConfig) Reset 

func (x *SemanticRetrieverConfig) Reset()

func (*SemanticRetrieverConfig) String 

func (x *SemanticRetrieverConfig) String() string

type StringList 

type StringList struct {

	// The string values of the metadata to store.
	Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

User provided string values assigned to a single metadata key.

func (*StringList) Descriptor deprecated 

func (*StringList) Descriptor() ([]byte, []int)

Deprecated: Use StringList.ProtoReflect.Descriptor instead.

func (*StringList) GetValues 

func (x *StringList) GetValues() []string

func (*StringList) ProtoMessage 

func (*StringList) ProtoMessage()

func (*StringList) ProtoReflect 

func (x *StringList) ProtoReflect() protoreflect.Message

func (*StringList) Reset 

func (x *StringList) Reset()

func (*StringList) String 

func (x *StringList) String() string

type TaskType 

type TaskType int32

Type of task for which the embedding will be used. 

const (
	// Unset value, which will default to one of the other enum values.
	TaskType_TASK_TYPE_UNSPECIFIED TaskType = 0
	// Specifies the given text is a query in a search/retrieval setting.
	TaskType_RETRIEVAL_QUERY TaskType = 1
	// Specifies the given text is a document from the corpus being searched.
	TaskType_RETRIEVAL_DOCUMENT TaskType = 2
	// Specifies the given text will be used for STS.
	TaskType_SEMANTIC_SIMILARITY TaskType = 3
	// Specifies that the given text will be classified.
	TaskType_CLASSIFICATION TaskType = 4
	// Specifies that the embeddings will be used for clustering.
	TaskType_CLUSTERING TaskType = 5
	// Specifies that the given text will be used for question answering.
	TaskType_QUESTION_ANSWERING TaskType = 6
	// Specifies that the given text will be used for fact verification.
	TaskType_FACT_VERIFICATION TaskType = 7
)

func (TaskType) Descriptor 

func (TaskType) Descriptor() protoreflect.EnumDescriptor

func (TaskType) Enum 

func (x TaskType) Enum() *TaskType

func (TaskType) EnumDescriptor deprecated 

func (TaskType) EnumDescriptor() ([]byte, []int)

Deprecated: Use TaskType.Descriptor instead.

func (TaskType) Number 

func (x TaskType) Number() protoreflect.EnumNumber

func (TaskType) String 

func (x TaskType) String() string

func (TaskType) Type 

func (TaskType) Type() protoreflect.EnumType

type TextCompletion 

type TextCompletion struct {

	// Output only. The generated text returned from the model.
	Output string `protobuf:"bytes,1,opt,name=output,proto3" json:"output,omitempty"`
	// Ratings for the safety of a response.
	//
	// There is at most one rating per category.
	SafetyRatings []*SafetyRating `protobuf:"bytes,2,rep,name=safety_ratings,json=safetyRatings,proto3" json:"safety_ratings,omitempty"`
	// Output only. Citation information for model-generated `output` in this
	// `TextCompletion`.
	//
	// This field may be populated with attribution information for any text
	// included in the `output`.
	CitationMetadata *CitationMetadata `protobuf:"bytes,3,opt,name=citation_metadata,json=citationMetadata,proto3,oneof" json:"citation_metadata,omitempty"`
	// contains filtered or unexported fields
}

Output text returned from a model.

func (*TextCompletion) Descriptor deprecated 

func (*TextCompletion) Descriptor() ([]byte, []int)

Deprecated: Use TextCompletion.ProtoReflect.Descriptor instead.

func (*TextCompletion) GetCitationMetadata 

func (x *TextCompletion) GetCitationMetadata() *CitationMetadata

func (*TextCompletion) GetOutput 

func (x *TextCompletion) GetOutput() string

func (*TextCompletion) GetSafetyRatings 

func (x *TextCompletion) GetSafetyRatings() []*SafetyRating

func (*TextCompletion) ProtoMessage 

func (*TextCompletion) ProtoMessage()

func (*TextCompletion) ProtoReflect 

func (x *TextCompletion) ProtoReflect() protoreflect.Message

func (*TextCompletion) Reset 

func (x *TextCompletion) Reset()

func (*TextCompletion) String 

func (x *TextCompletion) String() string

type TextPrompt 

type TextPrompt struct {

	// Required. The prompt text.
	Text string `protobuf:"bytes,1,opt,name=text,proto3" json:"text,omitempty"`
	// contains filtered or unexported fields
}

Text given to the model as a prompt.

The Model will use this TextPrompt to Generate a text completion.

func (*TextPrompt) Descriptor deprecated 

func (*TextPrompt) Descriptor() ([]byte, []int)

Deprecated: Use TextPrompt.ProtoReflect.Descriptor instead.

func (*TextPrompt) GetText 

func (x *TextPrompt) GetText() string

func (*TextPrompt) ProtoMessage 

func (*TextPrompt) ProtoMessage()

func (*TextPrompt) ProtoReflect 

func (x *TextPrompt) ProtoReflect() protoreflect.Message

func (*TextPrompt) Reset 

func (x *TextPrompt) Reset()

func (*TextPrompt) String 

func (x *TextPrompt) String() string

type TextServiceClient 

type TextServiceClient interface {
	// Generates a response from the model given an input message.
	GenerateText(ctx context.Context, in *GenerateTextRequest, opts ...grpc.CallOption) (*GenerateTextResponse, error)
	// Generates an embedding from the model given an input message.
	EmbedText(ctx context.Context, in *EmbedTextRequest, opts ...grpc.CallOption) (*EmbedTextResponse, error)
	// Generates multiple embeddings from the model given input text in a
	// synchronous call.
	BatchEmbedText(ctx context.Context, in *BatchEmbedTextRequest, opts ...grpc.CallOption) (*BatchEmbedTextResponse, error)
	// Runs a model's tokenizer on a text and returns the token count.
	CountTextTokens(ctx context.Context, in *CountTextTokensRequest, opts ...grpc.CallOption) (*CountTextTokensResponse, error)
}

TextServiceClient is the client API for TextService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewTextServiceClient 

func NewTextServiceClient(cc grpc.ClientConnInterface) TextServiceClient

type TextServiceServer 

type TextServiceServer interface {
	// Generates a response from the model given an input message.
	GenerateText(context.Context, *GenerateTextRequest) (*GenerateTextResponse, error)
	// Generates an embedding from the model given an input message.
	EmbedText(context.Context, *EmbedTextRequest) (*EmbedTextResponse, error)
	// Generates multiple embeddings from the model given input text in a
	// synchronous call.
	BatchEmbedText(context.Context, *BatchEmbedTextRequest) (*BatchEmbedTextResponse, error)
	// Runs a model's tokenizer on a text and returns the token count.
	CountTextTokens(context.Context, *CountTextTokensRequest) (*CountTextTokensResponse, error)
}

TextServiceServer is the server API for TextService service.

type Tool 

type Tool struct {

	// Optional. A list of `FunctionDeclarations` available to the model that can
	// be used for function calling.
	//
	// The model or system does not execute the function. Instead the defined
	// function may be returned as a [FunctionCall][content.part.function_call]
	// with arguments to the client side for execution. The model may decide to
	// call a subset of these functions by populating
	// [FunctionCall][content.part.function_call] in the response. The next
	// conversation turn may contain a
	// [FunctionResponse][content.part.function_response]
	// with the [content.role] "function" generation context for the next model
	// turn.
	FunctionDeclarations []*FunctionDeclaration `protobuf:"bytes,1,rep,name=function_declarations,json=functionDeclarations,proto3" json:"function_declarations,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*Tool) Descriptor deprecated 

func (*Tool) Descriptor() ([]byte, []int)

Deprecated: Use Tool.ProtoReflect.Descriptor instead.

func (*Tool) GetFunctionDeclarations 

func (x *Tool) GetFunctionDeclarations() []*FunctionDeclaration

func (*Tool) ProtoMessage 

func (*Tool) ProtoMessage()

func (*Tool) ProtoReflect 

func (x *Tool) ProtoReflect() protoreflect.Message

func (*Tool) Reset 

func (x *Tool) Reset()

func (*Tool) String 

func (x *Tool) String() string

type ToolConfig 

type ToolConfig struct {

	// Optional. Function calling config.
	FunctionCallingConfig *FunctionCallingConfig `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

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

func (*ToolConfig) Descriptor deprecated 

func (*ToolConfig) Descriptor() ([]byte, []int)

Deprecated: Use ToolConfig.ProtoReflect.Descriptor instead.

func (*ToolConfig) GetFunctionCallingConfig 

func (x *ToolConfig) GetFunctionCallingConfig() *FunctionCallingConfig

func (*ToolConfig) ProtoMessage 

func (*ToolConfig) ProtoMessage()

func (*ToolConfig) ProtoReflect 

func (x *ToolConfig) ProtoReflect() protoreflect.Message

func (*ToolConfig) Reset 

func (x *ToolConfig) Reset()

func (*ToolConfig) String 

func (x *ToolConfig) String() string

type TransferOwnershipRequest 

type TransferOwnershipRequest struct {

	// Required. The resource name of the tuned model to transfer ownership.
	//
	// Format: `tunedModels/my-model-id`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Required. The email address of the user to whom the tuned model is being
	// transferred to.
	EmailAddress string `protobuf:"bytes,2,opt,name=email_address,json=emailAddress,proto3" json:"email_address,omitempty"`
	// contains filtered or unexported fields
}

Request to transfer the ownership of the tuned model.

func (*TransferOwnershipRequest) Descriptor deprecated 

func (*TransferOwnershipRequest) Descriptor() ([]byte, []int)

Deprecated: Use TransferOwnershipRequest.ProtoReflect.Descriptor instead.

func (*TransferOwnershipRequest) GetEmailAddress 

func (x *TransferOwnershipRequest) GetEmailAddress() string

func (*TransferOwnershipRequest) GetName 

func (x *TransferOwnershipRequest) GetName() string

func (*TransferOwnershipRequest) ProtoMessage 

func (*TransferOwnershipRequest) ProtoMessage()

func (*TransferOwnershipRequest) ProtoReflect 

func (x *TransferOwnershipRequest) ProtoReflect() protoreflect.Message

func (*TransferOwnershipRequest) Reset 

func (x *TransferOwnershipRequest) Reset()

func (*TransferOwnershipRequest) String 

func (x *TransferOwnershipRequest) String() string

type TransferOwnershipResponse 

type TransferOwnershipResponse struct {
	// contains filtered or unexported fields
}

Response from `TransferOwnership`.

func (*TransferOwnershipResponse) Descriptor deprecated 

func (*TransferOwnershipResponse) Descriptor() ([]byte, []int)

Deprecated: Use TransferOwnershipResponse.ProtoReflect.Descriptor instead.

func (*TransferOwnershipResponse) ProtoMessage 

func (*TransferOwnershipResponse) ProtoMessage()

func (*TransferOwnershipResponse) ProtoReflect 

func (x *TransferOwnershipResponse) ProtoReflect() protoreflect.Message

func (*TransferOwnershipResponse) Reset 

func (x *TransferOwnershipResponse) Reset()

func (*TransferOwnershipResponse) String 

func (x *TransferOwnershipResponse) String() string

type TunedModel 

type TunedModel struct {

	// The model used as the starting point for tuning.
	//
	// Types that are assignable to SourceModel:
	//
	//	*TunedModel_TunedModelSource
	//	*TunedModel_BaseModel
	SourceModel isTunedModel_SourceModel `protobuf_oneof:"source_model"`
	// Output only. The tuned model name. A unique name will be generated on
	// create. Example: `tunedModels/az2mb0bpw6i` If display_name is set on
	// create, the id portion of the name will be set by concatenating the words
	// of the display_name with hyphens and adding a random portion for
	// uniqueness. Example:
	//
	//	display_name = "Sentence Translator"
	//	name = "tunedModels/sentence-translator-u3b7m"
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The name to display for this model in user interfaces.
	// The display name must be up to 40 characters including spaces.
	DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Optional. A short description of this model.
	Description string `protobuf:"bytes,6,opt,name=description,proto3" json:"description,omitempty"`
	// Optional. Controls the randomness of the output.
	//
	// Values can range over `[0.0,1.0]`, inclusive. A value closer to `1.0` will
	// produce responses that are more varied, while a value closer to `0.0` will
	// typically result in less surprising responses from the model.
	//
	// This value specifies default to be the one used by the base model while
	// creating the model.
	Temperature *float32 `protobuf:"fixed32,11,opt,name=temperature,proto3,oneof" json:"temperature,omitempty"`
	// Optional. For Nucleus sampling.
	//
	// Nucleus sampling considers the smallest set of tokens whose probability
	// sum is at least `top_p`.
	//
	// This value specifies default to be the one used by the base model while
	// creating the model.
	TopP *float32 `protobuf:"fixed32,12,opt,name=top_p,json=topP,proto3,oneof" json:"top_p,omitempty"`
	// Optional. For Top-k sampling.
	//
	// Top-k sampling considers the set of `top_k` most probable tokens.
	// This value specifies default to be used by the backend while making the
	// call to the model.
	//
	// This value specifies default to be the one used by the base model while
	// creating the model.
	TopK *int32 `protobuf:"varint,13,opt,name=top_k,json=topK,proto3,oneof" json:"top_k,omitempty"`
	// Output only. The state of the tuned model.
	State TunedModel_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.ai.generativelanguage.v1beta.TunedModel_State" json:"state,omitempty"`
	// Output only. The timestamp when this model was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The timestamp when this model was updated.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Required. The tuning task that creates the tuned model.
	TuningTask *TuningTask `protobuf:"bytes,10,opt,name=tuning_task,json=tuningTask,proto3" json:"tuning_task,omitempty"`
	// contains filtered or unexported fields
}

A fine-tuned model created using ModelService.CreateTunedModel.

func (*TunedModel) Descriptor deprecated 

func (*TunedModel) Descriptor() ([]byte, []int)

Deprecated: Use TunedModel.ProtoReflect.Descriptor instead.

func (*TunedModel) GetBaseModel 

func (x *TunedModel) GetBaseModel() string

func (*TunedModel) GetCreateTime 

func (x *TunedModel) GetCreateTime() *timestamppb.Timestamp

func (*TunedModel) GetDescription 

func (x *TunedModel) GetDescription() string

func (*TunedModel) GetDisplayName 

func (x *TunedModel) GetDisplayName() string

func (*TunedModel) GetName 

func (x *TunedModel) GetName() string

func (*TunedModel) GetSourceModel 

func (m *TunedModel) GetSourceModel() isTunedModel_SourceModel

func (*TunedModel) GetState 

func (x *TunedModel) GetState() TunedModel_State

func (*TunedModel) GetTemperature 

func (x *TunedModel) GetTemperature() float32

func (*TunedModel) GetTopK 

func (x *TunedModel) GetTopK() int32

func (*TunedModel) GetTopP 

func (x *TunedModel) GetTopP() float32

func (*TunedModel) GetTunedModelSource 

func (x *TunedModel) GetTunedModelSource() *TunedModelSource

func (*TunedModel) GetTuningTask 

func (x *TunedModel) GetTuningTask() *TuningTask

func (*TunedModel) GetUpdateTime 

func (x *TunedModel) GetUpdateTime() *timestamppb.Timestamp

func (*TunedModel) ProtoMessage 

func (*TunedModel) ProtoMessage()

func (*TunedModel) ProtoReflect 

func (x *TunedModel) ProtoReflect() protoreflect.Message

func (*TunedModel) Reset 

func (x *TunedModel) Reset()

func (*TunedModel) String 

func (x *TunedModel) String() string

type TunedModelSource 

type TunedModelSource struct {

	// Immutable. The name of the `TunedModel` to use as the starting point for
	// training the new model.
	// Example: `tunedModels/my-tuned-model`
	TunedModel string `protobuf:"bytes,1,opt,name=tuned_model,json=tunedModel,proto3" json:"tuned_model,omitempty"`
	// Output only. The name of the base `Model` this `TunedModel` was tuned from.
	// Example: `models/text-bison-001`
	BaseModel string `protobuf:"bytes,2,opt,name=base_model,json=baseModel,proto3" json:"base_model,omitempty"`
	// contains filtered or unexported fields
}

Tuned model as a source for training a new model.

func (*TunedModelSource) Descriptor deprecated 

func (*TunedModelSource) Descriptor() ([]byte, []int)

Deprecated: Use TunedModelSource.ProtoReflect.Descriptor instead.

func (*TunedModelSource) GetBaseModel 

func (x *TunedModelSource) GetBaseModel() string

func (*TunedModelSource) GetTunedModel 

func (x *TunedModelSource) GetTunedModel() string

func (*TunedModelSource) ProtoMessage 

func (*TunedModelSource) ProtoMessage()

func (*TunedModelSource) ProtoReflect 

func (x *TunedModelSource) ProtoReflect() protoreflect.Message

func (*TunedModelSource) Reset 

func (x *TunedModelSource) Reset()

func (*TunedModelSource) String 

func (x *TunedModelSource) String() string

type TunedModel_BaseModel 

type TunedModel_BaseModel struct {
	// Immutable. The name of the `Model` to tune.
	// Example: `models/text-bison-001`
	BaseModel string `protobuf:"bytes,4,opt,name=base_model,json=baseModel,proto3,oneof"`
}

type TunedModel_State 

type TunedModel_State int32

The state of the tuned model. 

const (
	// The default value. This value is unused.
	TunedModel_STATE_UNSPECIFIED TunedModel_State = 0
	// The model is being created.
	TunedModel_CREATING TunedModel_State = 1
	// The model is ready to be used.
	TunedModel_ACTIVE TunedModel_State = 2
	// The model failed to be created.
	TunedModel_FAILED TunedModel_State = 3
)

func (TunedModel_State) Descriptor 

func (TunedModel_State) Descriptor() protoreflect.EnumDescriptor

func (TunedModel_State) Enum 

func (x TunedModel_State) Enum() *TunedModel_State

func (TunedModel_State) EnumDescriptor deprecated 

func (TunedModel_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use TunedModel_State.Descriptor instead.

func (TunedModel_State) Number 

func (x TunedModel_State) Number() protoreflect.EnumNumber

func (TunedModel_State) String 

func (x TunedModel_State) String() string

func (TunedModel_State) Type 

func (TunedModel_State) Type() protoreflect.EnumType

type TunedModel_TunedModelSource 

type TunedModel_TunedModelSource struct {
	// Optional. TunedModel to use as the starting point for training the new
	// model.
	TunedModelSource *TunedModelSource `protobuf:"bytes,3,opt,name=tuned_model_source,json=tunedModelSource,proto3,oneof"`
}

type TuningExample 

type TuningExample struct {

	// The input to the model for this example.
	//
	// Types that are assignable to ModelInput:
	//
	//	*TuningExample_TextInput
	ModelInput isTuningExample_ModelInput `protobuf_oneof:"model_input"`
	// Required. The expected model output.
	Output string `protobuf:"bytes,3,opt,name=output,proto3" json:"output,omitempty"`
	// contains filtered or unexported fields
}

A single example for tuning.

func (*TuningExample) Descriptor deprecated 

func (*TuningExample) Descriptor() ([]byte, []int)

Deprecated: Use TuningExample.ProtoReflect.Descriptor instead.

func (*TuningExample) GetModelInput 

func (m *TuningExample) GetModelInput() isTuningExample_ModelInput

func (*TuningExample) GetOutput 

func (x *TuningExample) GetOutput() string

func (*TuningExample) GetTextInput 

func (x *TuningExample) GetTextInput() string

func (*TuningExample) ProtoMessage 

func (*TuningExample) ProtoMessage()

func (*TuningExample) ProtoReflect 

func (x *TuningExample) ProtoReflect() protoreflect.Message

func (*TuningExample) Reset 

func (x *TuningExample) Reset()

func (*TuningExample) String 

func (x *TuningExample) String() string

type TuningExample_TextInput 

type TuningExample_TextInput struct {
	// Optional. Text model input.
	TextInput string `protobuf:"bytes,1,opt,name=text_input,json=textInput,proto3,oneof"`
}

type TuningExamples 

type TuningExamples struct {

	// Required. The examples. Example input can be for text or discuss, but all
	// examples in a set must be of the same type.
	Examples []*TuningExample `protobuf:"bytes,1,rep,name=examples,proto3" json:"examples,omitempty"`
	// contains filtered or unexported fields
}

A set of tuning examples. Can be training or validation data.

func (*TuningExamples) Descriptor deprecated 

func (*TuningExamples) Descriptor() ([]byte, []int)

Deprecated: Use TuningExamples.ProtoReflect.Descriptor instead.

func (*TuningExamples) GetExamples 

func (x *TuningExamples) GetExamples() []*TuningExample

func (*TuningExamples) ProtoMessage 

func (*TuningExamples) ProtoMessage()

func (*TuningExamples) ProtoReflect 

func (x *TuningExamples) ProtoReflect() protoreflect.Message

func (*TuningExamples) Reset 

func (x *TuningExamples) Reset()

func (*TuningExamples) String 

func (x *TuningExamples) String() string

type TuningSnapshot 

type TuningSnapshot struct {

	// Output only. The tuning step.
	Step int32 `protobuf:"varint,1,opt,name=step,proto3" json:"step,omitempty"`
	// Output only. The epoch this step was part of.
	Epoch int32 `protobuf:"varint,2,opt,name=epoch,proto3" json:"epoch,omitempty"`
	// Output only. The mean loss of the training examples for this step.
	MeanLoss float32 `protobuf:"fixed32,3,opt,name=mean_loss,json=meanLoss,proto3" json:"mean_loss,omitempty"`
	// Output only. The timestamp when this metric was computed.
	ComputeTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=compute_time,json=computeTime,proto3" json:"compute_time,omitempty"`
	// contains filtered or unexported fields
}

Record for a single tuning step.

func (*TuningSnapshot) Descriptor deprecated 

func (*TuningSnapshot) Descriptor() ([]byte, []int)

Deprecated: Use TuningSnapshot.ProtoReflect.Descriptor instead.

func (*TuningSnapshot) GetComputeTime 

func (x *TuningSnapshot) GetComputeTime() *timestamppb.Timestamp

func (*TuningSnapshot) GetEpoch 

func (x *TuningSnapshot) GetEpoch() int32

func (*TuningSnapshot) GetMeanLoss 

func (x *TuningSnapshot) GetMeanLoss() float32

func (*TuningSnapshot) GetStep 

func (x *TuningSnapshot) GetStep() int32

func (*TuningSnapshot) ProtoMessage 

func (*TuningSnapshot) ProtoMessage()

func (*TuningSnapshot) ProtoReflect 

func (x *TuningSnapshot) ProtoReflect() protoreflect.Message

func (*TuningSnapshot) Reset 

func (x *TuningSnapshot) Reset()

func (*TuningSnapshot) String 

func (x *TuningSnapshot) String() string

type TuningTask 

type TuningTask struct {

	// Output only. The timestamp when tuning this model started.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. The timestamp when tuning this model completed.
	CompleteTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=complete_time,json=completeTime,proto3" json:"complete_time,omitempty"`
	// Output only. Metrics collected during tuning.
	Snapshots []*TuningSnapshot `protobuf:"bytes,3,rep,name=snapshots,proto3" json:"snapshots,omitempty"`
	// Required. Input only. Immutable. The model training data.
	TrainingData *Dataset `protobuf:"bytes,4,opt,name=training_data,json=trainingData,proto3" json:"training_data,omitempty"`
	// Immutable. Hyperparameters controlling the tuning process. If not provided,
	// default values will be used.
	Hyperparameters *Hyperparameters `protobuf:"bytes,5,opt,name=hyperparameters,proto3" json:"hyperparameters,omitempty"`
	// contains filtered or unexported fields
}

Tuning tasks that create tuned models.

func (*TuningTask) Descriptor deprecated 

func (*TuningTask) Descriptor() ([]byte, []int)

Deprecated: Use TuningTask.ProtoReflect.Descriptor instead.

func (*TuningTask) GetCompleteTime 

func (x *TuningTask) GetCompleteTime() *timestamppb.Timestamp

func (*TuningTask) GetHyperparameters 

func (x *TuningTask) GetHyperparameters() *Hyperparameters

func (*TuningTask) GetSnapshots 

func (x *TuningTask) GetSnapshots() []*TuningSnapshot

func (*TuningTask) GetStartTime 

func (x *TuningTask) GetStartTime() *timestamppb.Timestamp

func (*TuningTask) GetTrainingData 

func (x *TuningTask) GetTrainingData() *Dataset

func (*TuningTask) ProtoMessage 

func (*TuningTask) ProtoMessage()

func (*TuningTask) ProtoReflect 

func (x *TuningTask) ProtoReflect() protoreflect.Message

func (*TuningTask) Reset 

func (x *TuningTask) Reset()

func (*TuningTask) String 

func (x *TuningTask) String() string

type Type 

type Type int32

Type contains the list of OpenAPI data types as defined by https://spec.openapis.org/oas/v3.0.3#data-types 

const (
	// Not specified, should not be used.
	Type_TYPE_UNSPECIFIED Type = 0
	// String type.
	Type_STRING Type = 1
	// Number type.
	Type_NUMBER Type = 2
	// Integer type.
	Type_INTEGER Type = 3
	// Boolean type.
	Type_BOOLEAN Type = 4
	// Array type.
	Type_ARRAY Type = 5
	// Object type.
	Type_OBJECT Type = 6
)

func (Type) Descriptor 

func (Type) Descriptor() protoreflect.EnumDescriptor

func (Type) Enum 

func (x Type) Enum() *Type

func (Type) EnumDescriptor deprecated 

func (Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Type.Descriptor instead.

func (Type) Number 

func (x Type) Number() protoreflect.EnumNumber

func (Type) String 

func (x Type) String() string

func (Type) Type 

func (Type) Type() protoreflect.EnumType

type UnimplementedDiscussServiceServer 

type UnimplementedDiscussServiceServer struct {
}

UnimplementedDiscussServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedDiscussServiceServer) CountMessageTokens 

func (*UnimplementedDiscussServiceServer) CountMessageTokens(context.Context, *CountMessageTokensRequest) (*CountMessageTokensResponse, error)

func (*UnimplementedDiscussServiceServer) GenerateMessage 

func (*UnimplementedDiscussServiceServer) GenerateMessage(context.Context, *GenerateMessageRequest) (*GenerateMessageResponse, error)

type UnimplementedFileServiceServer 

type UnimplementedFileServiceServer struct {
}

UnimplementedFileServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedFileServiceServer) CreateFile 

func (*UnimplementedFileServiceServer) CreateFile(context.Context, *CreateFileRequest) (*CreateFileResponse, error)

func (*UnimplementedFileServiceServer) DeleteFile 

func (*UnimplementedFileServiceServer) DeleteFile(context.Context, *DeleteFileRequest) (*emptypb.Empty, error)

func (*UnimplementedFileServiceServer) GetFile 

func (*UnimplementedFileServiceServer) GetFile(context.Context, *GetFileRequest) (*File, error)

func (*UnimplementedFileServiceServer) ListFiles 

func (*UnimplementedFileServiceServer) ListFiles(context.Context, *ListFilesRequest) (*ListFilesResponse, error)

type UnimplementedGenerativeServiceServer 

type UnimplementedGenerativeServiceServer struct {
}

UnimplementedGenerativeServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedGenerativeServiceServer) BatchEmbedContents 

func (*UnimplementedGenerativeServiceServer) BatchEmbedContents(context.Context, *BatchEmbedContentsRequest) (*BatchEmbedContentsResponse, error)

func (*UnimplementedGenerativeServiceServer) CountTokens 

func (*UnimplementedGenerativeServiceServer) CountTokens(context.Context, *CountTokensRequest) (*CountTokensResponse, error)

func (*UnimplementedGenerativeServiceServer) EmbedContent 

func (*UnimplementedGenerativeServiceServer) EmbedContent(context.Context, *EmbedContentRequest) (*EmbedContentResponse, error)

func (*UnimplementedGenerativeServiceServer) GenerateAnswer 

func (*UnimplementedGenerativeServiceServer) GenerateAnswer(context.Context, *GenerateAnswerRequest) (*GenerateAnswerResponse, error)

func (*UnimplementedGenerativeServiceServer) GenerateContent 

func (*UnimplementedGenerativeServiceServer) GenerateContent(context.Context, *GenerateContentRequest) (*GenerateContentResponse, error)

func (*UnimplementedGenerativeServiceServer) StreamGenerateContent 

func (*UnimplementedGenerativeServiceServer) StreamGenerateContent(*GenerateContentRequest, GenerativeService_StreamGenerateContentServer) error

type UnimplementedModelServiceServer 

type UnimplementedModelServiceServer struct {
}

UnimplementedModelServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedModelServiceServer) CreateTunedModel 

func (*UnimplementedModelServiceServer) CreateTunedModel(context.Context, *CreateTunedModelRequest) (*longrunningpb.Operation, error)

func (*UnimplementedModelServiceServer) DeleteTunedModel 

func (*UnimplementedModelServiceServer) DeleteTunedModel(context.Context, *DeleteTunedModelRequest) (*emptypb.Empty, error)

func (*UnimplementedModelServiceServer) GetModel 

func (*UnimplementedModelServiceServer) GetModel(context.Context, *GetModelRequest) (*Model, error)

func (*UnimplementedModelServiceServer) GetTunedModel 

func (*UnimplementedModelServiceServer) GetTunedModel(context.Context, *GetTunedModelRequest) (*TunedModel, error)

func (*UnimplementedModelServiceServer) ListModels 

func (*UnimplementedModelServiceServer) ListModels(context.Context, *ListModelsRequest) (*ListModelsResponse, error)

func (*UnimplementedModelServiceServer) ListTunedModels 

func (*UnimplementedModelServiceServer) ListTunedModels(context.Context, *ListTunedModelsRequest) (*ListTunedModelsResponse, error)

func (*UnimplementedModelServiceServer) UpdateTunedModel 

func (*UnimplementedModelServiceServer) UpdateTunedModel(context.Context, *UpdateTunedModelRequest) (*TunedModel, error)

type UnimplementedPermissionServiceServer 

type UnimplementedPermissionServiceServer struct {
}

UnimplementedPermissionServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedPermissionServiceServer) CreatePermission 

func (*UnimplementedPermissionServiceServer) CreatePermission(context.Context, *CreatePermissionRequest) (*Permission, error)

func (*UnimplementedPermissionServiceServer) DeletePermission 

func (*UnimplementedPermissionServiceServer) DeletePermission(context.Context, *DeletePermissionRequest) (*emptypb.Empty, error)

func (*UnimplementedPermissionServiceServer) GetPermission 

func (*UnimplementedPermissionServiceServer) GetPermission(context.Context, *GetPermissionRequest) (*Permission, error)

func (*UnimplementedPermissionServiceServer) ListPermissions 

func (*UnimplementedPermissionServiceServer) ListPermissions(context.Context, *ListPermissionsRequest) (*ListPermissionsResponse, error)

func (*UnimplementedPermissionServiceServer) TransferOwnership 

func (*UnimplementedPermissionServiceServer) TransferOwnership(context.Context, *TransferOwnershipRequest) (*TransferOwnershipResponse, error)

func (*UnimplementedPermissionServiceServer) UpdatePermission 

func (*UnimplementedPermissionServiceServer) UpdatePermission(context.Context, *UpdatePermissionRequest) (*Permission, error)

type UnimplementedRetrieverServiceServer 

type UnimplementedRetrieverServiceServer struct {
}

UnimplementedRetrieverServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedRetrieverServiceServer) BatchCreateChunks 

func (*UnimplementedRetrieverServiceServer) BatchCreateChunks(context.Context, *BatchCreateChunksRequest) (*BatchCreateChunksResponse, error)

func (*UnimplementedRetrieverServiceServer) BatchDeleteChunks 

func (*UnimplementedRetrieverServiceServer) BatchDeleteChunks(context.Context, *BatchDeleteChunksRequest) (*emptypb.Empty, error)

func (*UnimplementedRetrieverServiceServer) BatchUpdateChunks 

func (*UnimplementedRetrieverServiceServer) BatchUpdateChunks(context.Context, *BatchUpdateChunksRequest) (*BatchUpdateChunksResponse, error)

func (*UnimplementedRetrieverServiceServer) CreateChunk 

func (*UnimplementedRetrieverServiceServer) CreateChunk(context.Context, *CreateChunkRequest) (*Chunk, error)

func (*UnimplementedRetrieverServiceServer) CreateCorpus 

func (*UnimplementedRetrieverServiceServer) CreateCorpus(context.Context, *CreateCorpusRequest) (*Corpus, error)

func (*UnimplementedRetrieverServiceServer) CreateDocument 

func (*UnimplementedRetrieverServiceServer) CreateDocument(context.Context, *CreateDocumentRequest) (*Document, error)

func (*UnimplementedRetrieverServiceServer) DeleteChunk 

func (*UnimplementedRetrieverServiceServer) DeleteChunk(context.Context, *DeleteChunkRequest) (*emptypb.Empty, error)

func (*UnimplementedRetrieverServiceServer) DeleteCorpus 

func (*UnimplementedRetrieverServiceServer) DeleteCorpus(context.Context, *DeleteCorpusRequest) (*emptypb.Empty, error)

func (*UnimplementedRetrieverServiceServer) DeleteDocument 

func (*UnimplementedRetrieverServiceServer) DeleteDocument(context.Context, *DeleteDocumentRequest) (*emptypb.Empty, error)

func (*UnimplementedRetrieverServiceServer) GetChunk 

func (*UnimplementedRetrieverServiceServer) GetChunk(context.Context, *GetChunkRequest) (*Chunk, error)

func (*UnimplementedRetrieverServiceServer) GetCorpus 

func (*UnimplementedRetrieverServiceServer) GetCorpus(context.Context, *GetCorpusRequest) (*Corpus, error)

func (*UnimplementedRetrieverServiceServer) GetDocument 

func (*UnimplementedRetrieverServiceServer) GetDocument(context.Context, *GetDocumentRequest) (*Document, error)

func (*UnimplementedRetrieverServiceServer) ListChunks 

func (*UnimplementedRetrieverServiceServer) ListChunks(context.Context, *ListChunksRequest) (*ListChunksResponse, error)

func (*UnimplementedRetrieverServiceServer) ListCorpora 

func (*UnimplementedRetrieverServiceServer) ListCorpora(context.Context, *ListCorporaRequest) (*ListCorporaResponse, error)

func (*UnimplementedRetrieverServiceServer) ListDocuments 

func (*UnimplementedRetrieverServiceServer) ListDocuments(context.Context, *ListDocumentsRequest) (*ListDocumentsResponse, error)

func (*UnimplementedRetrieverServiceServer) QueryCorpus 

func (*UnimplementedRetrieverServiceServer) QueryCorpus(context.Context, *QueryCorpusRequest) (*QueryCorpusResponse, error)

func (*UnimplementedRetrieverServiceServer) QueryDocument 

func (*UnimplementedRetrieverServiceServer) QueryDocument(context.Context, *QueryDocumentRequest) (*QueryDocumentResponse, error)

func (*UnimplementedRetrieverServiceServer) UpdateChunk 

func (*UnimplementedRetrieverServiceServer) UpdateChunk(context.Context, *UpdateChunkRequest) (*Chunk, error)

func (*UnimplementedRetrieverServiceServer) UpdateCorpus 

func (*UnimplementedRetrieverServiceServer) UpdateCorpus(context.Context, *UpdateCorpusRequest) (*Corpus, error)

func (*UnimplementedRetrieverServiceServer) UpdateDocument 

func (*UnimplementedRetrieverServiceServer) UpdateDocument(context.Context, *UpdateDocumentRequest) (*Document, error)

type UnimplementedTextServiceServer 

type UnimplementedTextServiceServer struct {
}

UnimplementedTextServiceServer can be embedded to have forward compatible implementations.

func (*UnimplementedTextServiceServer) BatchEmbedText 

func (*UnimplementedTextServiceServer) BatchEmbedText(context.Context, *BatchEmbedTextRequest) (*BatchEmbedTextResponse, error)

func (*UnimplementedTextServiceServer) CountTextTokens 

func (*UnimplementedTextServiceServer) CountTextTokens(context.Context, *CountTextTokensRequest) (*CountTextTokensResponse, error)

func (*UnimplementedTextServiceServer) EmbedText 

func (*UnimplementedTextServiceServer) EmbedText(context.Context, *EmbedTextRequest) (*EmbedTextResponse, error)

func (*UnimplementedTextServiceServer) GenerateText 

func (*UnimplementedTextServiceServer) GenerateText(context.Context, *GenerateTextRequest) (*GenerateTextResponse, error)

type UpdateChunkRequest 

type UpdateChunkRequest struct {

	// Required. The `Chunk` to update.
	Chunk *Chunk `protobuf:"bytes,1,opt,name=chunk,proto3" json:"chunk,omitempty"`
	// Required. The list of fields to update.
	// Currently, this only supports updating `custom_metadata` and `data`.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request to update a `Chunk`.

func (*UpdateChunkRequest) Descriptor deprecated 

func (*UpdateChunkRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateChunkRequest.ProtoReflect.Descriptor instead.

func (*UpdateChunkRequest) GetChunk 

func (x *UpdateChunkRequest) GetChunk() *Chunk

func (*UpdateChunkRequest) GetUpdateMask 

func (x *UpdateChunkRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateChunkRequest) ProtoMessage 

func (*UpdateChunkRequest) ProtoMessage()

func (*UpdateChunkRequest) ProtoReflect 

func (x *UpdateChunkRequest) ProtoReflect() protoreflect.Message

func (*UpdateChunkRequest) Reset 

func (x *UpdateChunkRequest) Reset()

func (*UpdateChunkRequest) String 

func (x *UpdateChunkRequest) String() string

type UpdateCorpusRequest 

type UpdateCorpusRequest struct {

	// Required. The `Corpus` to update.
	Corpus *Corpus `protobuf:"bytes,1,opt,name=corpus,proto3" json:"corpus,omitempty"`
	// Required. The list of fields to update.
	// Currently, this only supports updating `display_name`.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request to update a `Corpus`.

func (*UpdateCorpusRequest) Descriptor deprecated 

func (*UpdateCorpusRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateCorpusRequest.ProtoReflect.Descriptor instead.

func (*UpdateCorpusRequest) GetCorpus 

func (x *UpdateCorpusRequest) GetCorpus() *Corpus

func (*UpdateCorpusRequest) GetUpdateMask 

func (x *UpdateCorpusRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateCorpusRequest) ProtoMessage 

func (*UpdateCorpusRequest) ProtoMessage()

func (*UpdateCorpusRequest) ProtoReflect 

func (x *UpdateCorpusRequest) ProtoReflect() protoreflect.Message

func (*UpdateCorpusRequest) Reset 

func (x *UpdateCorpusRequest) Reset()

func (*UpdateCorpusRequest) String 

func (x *UpdateCorpusRequest) String() string

type UpdateDocumentRequest 

type UpdateDocumentRequest struct {

	// Required. The `Document` to update.
	Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// Required. The list of fields to update.
	// Currently, this only supports updating `display_name` and
	// `custom_metadata`.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request to update a `Document`.

func (*UpdateDocumentRequest) Descriptor deprecated 

func (*UpdateDocumentRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateDocumentRequest.ProtoReflect.Descriptor instead.

func (*UpdateDocumentRequest) GetDocument 

func (x *UpdateDocumentRequest) GetDocument() *Document

func (*UpdateDocumentRequest) GetUpdateMask 

func (x *UpdateDocumentRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateDocumentRequest) ProtoMessage 

func (*UpdateDocumentRequest) ProtoMessage()

func (*UpdateDocumentRequest) ProtoReflect 

func (x *UpdateDocumentRequest) ProtoReflect() protoreflect.Message

func (*UpdateDocumentRequest) Reset 

func (x *UpdateDocumentRequest) Reset()

func (*UpdateDocumentRequest) String 

func (x *UpdateDocumentRequest) String() string

type UpdatePermissionRequest 

type UpdatePermissionRequest struct {

	// Required. The permission to update.
	//
	// The permission's `name` field is used to identify the permission to update.
	Permission *Permission `protobuf:"bytes,1,opt,name=permission,proto3" json:"permission,omitempty"`
	// Required. The list of fields to update. Accepted ones:
	//   - role (`Permission.role` field)
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request to update the `Permission`.

func (*UpdatePermissionRequest) Descriptor deprecated 

func (*UpdatePermissionRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdatePermissionRequest.ProtoReflect.Descriptor instead.

func (*UpdatePermissionRequest) GetPermission 

func (x *UpdatePermissionRequest) GetPermission() *Permission

func (*UpdatePermissionRequest) GetUpdateMask 

func (x *UpdatePermissionRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdatePermissionRequest) ProtoMessage 

func (*UpdatePermissionRequest) ProtoMessage()

func (*UpdatePermissionRequest) ProtoReflect 

func (x *UpdatePermissionRequest) ProtoReflect() protoreflect.Message

func (*UpdatePermissionRequest) Reset 

func (x *UpdatePermissionRequest) Reset()

func (*UpdatePermissionRequest) String 

func (x *UpdatePermissionRequest) String() string

type UpdateTunedModelRequest 

type UpdateTunedModelRequest struct {

	// Required. The tuned model to update.
	TunedModel *TunedModel `protobuf:"bytes,1,opt,name=tuned_model,json=tunedModel,proto3" json:"tuned_model,omitempty"`
	// Required. The list of fields to update.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

Request to update a TunedModel.

func (*UpdateTunedModelRequest) Descriptor deprecated 

func (*UpdateTunedModelRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpdateTunedModelRequest.ProtoReflect.Descriptor instead.

func (*UpdateTunedModelRequest) GetTunedModel 

func (x *UpdateTunedModelRequest) GetTunedModel() *TunedModel

func (*UpdateTunedModelRequest) GetUpdateMask 

func (x *UpdateTunedModelRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateTunedModelRequest) ProtoMessage 

func (*UpdateTunedModelRequest) ProtoMessage()

func (*UpdateTunedModelRequest) ProtoReflect 

func (x *UpdateTunedModelRequest) ProtoReflect() protoreflect.Message

func (*UpdateTunedModelRequest) Reset 

func (x *UpdateTunedModelRequest) Reset()

func (*UpdateTunedModelRequest) String 

func (x *UpdateTunedModelRequest) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.