diff --git a/Documentation/DocSource/BreakingChanges.md b/Documentation/DocSource/BreakingChanges.md deleted file mode 100644 index 461fbea..0000000 --- a/Documentation/DocSource/BreakingChanges.md +++ /dev/null @@ -1,70 +0,0 @@ -# Breaking Changes Notice - -UGemini v2.0.0 contains many breaking changes. For breaking changes in newer versions, check the release's changelogs at . -To update your code to use UGemini 2.0.0, refer to the following list and table of changes: - -## General Changes -- `EnumExtensions` is now `GeminiContentTypeExtensions`. -- `GeminiTimeSpanJsonConverter` is now `GeminiSecondsToTimeSpanJsonConverter` in `Uralstech.UGemini`. -- The `fileId` field in the constructors for `GeminiFileDeleteRequest` and `GeminiFileGetRequest` has been renamed to `fileNameOrId`. -- All code previously marked as "deprecated" has been removed. - -## Namespace Changes - -| Class | Old Namespace | New Namespace | -|----------- |--------------- |--------------- | -| `GeminiContent` | `Uralstech.UGemini` | `Uralstech.UGemini.Models.Content` | -| `GeminiContentBlob` | `Uralstech.UGemini` | `Uralstech.UGemini.Models.Content` | -| `GeminiContentPart` | `Uralstech.UGemini` | `Uralstech.UGemini.Models.Content` | -| `GeminiFileData` | `Uralstech.UGemini` | `Uralstech.UGemini.Models.Content` | -| `GeminiRole` | `Uralstech.UGemini` | `Uralstech.UGemini.Models.Content` | -| `UnityExtensions` | `Uralstech.UGemini` | `Uralstech.UGemini.Models.Content` | -| `GeminiAttributionSourceId` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Content.Attribution` | -| `GeminiGroundingAttribution` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Content.Attribution` | -| `GeminiGroundingPassageId` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Content.Attribution` | -| `GeminiSemanticRetrieverChunk` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Content.Attribution` | -| `GeminiCitationMetadata` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Content.Citation` | -| `GeminiCitationSource` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Content.Citation` | -| `GeminiTokenCountRequest` | `Uralstech.UGemini.TokenCounting` | `Uralstech.UGemini.Models.CountTokens` | -| `GeminiTokenCountResponse` | `Uralstech.UGemini.TokenCounting` | `Uralstech.UGemini.Models.CountTokens` | -| `GeminiBatchEmbedContentRequest` | `Uralstech.UGemini.Embedding` | `Uralstech.UGemini.Models.Embedding` | -| `GeminiBatchEmbedContentResponse` | `Uralstech.UGemini.Embedding` | `Uralstech.UGemini.Models.Embedding` | -| `GeminiContentEmbedding` | `Uralstech.UGemini.Embedding` | `Uralstech.UGemini.Models.Embedding` | -| `GeminiEmbedContentRequest` | `Uralstech.UGemini.Embedding` | `Uralstech.UGemini.Models.Embedding` | -| `GeminiEmbedContentResponse` | `Uralstech.UGemini.Embedding` | `Uralstech.UGemini.Models.Embedding` | -| `GeminiEmbedTaskType` | `Uralstech.UGemini.Embedding` | `Uralstech.UGemini.Models.Embedding` | -| `GeminiGenerationConfiguration` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Generation` | -| `GeminiResponseType` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Generation` | -| `GeminiCandidate` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Generation.Candidate` | -| `GeminiPromptFeedback` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Generation.Candidate` | -| `GeminiUsageMetadata` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Generation.Candidate` | -| `GeminiFinishReason` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Generation.Candidate` | -| `GeminiChatRequest` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Generation.Chat` | -| `GeminiChatResponse` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Generation.Chat` | -| `GeminiAnswerRequest` | `Uralstech.UGemini.Answer` | `Uralstech.UGemini.Models.Generation.QuestionAnswering` | -| `GeminiAnswerResponse` | `Uralstech.UGemini.Answer` | `Uralstech.UGemini.Models.Generation.QuestionAnswering` | -| `GeminiAnswerStyle` | `Uralstech.UGemini.Answer` | `Uralstech.UGemini.Models.Generation.QuestionAnswering` | -| `GeminiGroundingPassage` | `Uralstech.UGemini.Answer` | `Uralstech.UGemini.Models.Generation.QuestionAnswering.Grounding` | -| `GeminiGroundingPassages` | `Uralstech.UGemini.Answer` | `Uralstech.UGemini.Models.Generation.QuestionAnswering.Grounding` | -| `GeminiMetadataCondition` | `Uralstech.UGemini.Answer` | `Uralstech.UGemini.Models.Generation.QuestionAnswering.SemanticRetriever` | -| `GeminiMetadataFilter` | `Uralstech.UGemini.Answer` | `Uralstech.UGemini.Models.Generation.QuestionAnswering.SemanticRetriever` | -| `GeminiSemanticRetrieverConfig` | `Uralstech.UGemini.Answer` | `Uralstech.UGemini.Models.Generation.QuestionAnswering.SemanticRetriever` | -| `GeminiMetadataConditionOperator` | `Uralstech.UGemini.Answer` | `Uralstech.UGemini.Models.Generation.QuestionAnswering.SemanticRetriever` | -| `GeminiSafetyRating` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Generation.Safety` | -| `GeminiSafetySettings` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Generation.Safety` | -| `GeminiBlockReason` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Generation.Safety` | -| `GeminiHarmProbability` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Generation.Safety` | -| `GeminiSafetyHarmBlockThreshold` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Generation.Safety` | -| `GeminiSafetyHarmCategory` | `Uralstech.UGemini.Chat` | `Uralstech.UGemini.Models.Generation.Safety` | -| `GeminiSchema` | `Uralstech.UGemini.Schema` | `Uralstech.UGemini.Models.Generation.Schema` | -| `GeminiSchemaDataFormat` | `Uralstech.UGemini.Schema` | `Uralstech.UGemini.Models.Generation.Schema` | -| `GeminiSchemaDataType` | `Uralstech.UGemini.Schema` | `Uralstech.UGemini.Models.Generation.Schema` | -| `GeminiFunctionCall` | `Uralstech.UGemini.Tools` | `Uralstech.UGemini.Models.Generation.Tools` | -| `GeminiFunctionResponse` | `Uralstech.UGemini.Tools` | `Uralstech.UGemini.Models.Generation.Tools` | -| `GeminiFunctionResponseContent` | `Uralstech.UGemini.Tools` | `Uralstech.UGemini.Models.Generation.Tools` | -| `GeminiFunctionCallingConfiguration` | `Uralstech.UGemini.Tools.Declaration` | `Uralstech.UGemini.Models.Generation.Tools.Declaration` | -| `GeminiFunctionDeclaration` | `Uralstech.UGemini.Tools.Declaration` | `Uralstech.UGemini.Models.Generation.Tools.Declaration` | -| `GeminiTool` | `Uralstech.UGemini.Tools.Declaration` | `Uralstech.UGemini.Models.Generation.Tools.Declaration` | -| `GeminiToolConfiguration` | `Uralstech.UGemini.Tools.Declaration` | `Uralstech.UGemini.Models.Generation.Tools.Declaration` | -| `GeminiFunctionCallingMode` | `Uralstech.UGemini.Tools.Declaration` | `Uralstech.UGemini.Models.Generation.Tools.Declaration` | -| | | | \ No newline at end of file diff --git a/Documentation/DocSource/QuickStart.md b/Documentation/DocSource/QuickStart.md index bb46369..4d12cc5 100644 --- a/Documentation/DocSource/QuickStart.md +++ b/Documentation/DocSource/QuickStart.md @@ -2,6 +2,10 @@ Please note that the code provided in this page is *purely* for learning purposes and is far from perfect. Remember to null-check all responses! +## Breaking Changes Notice + +If you've just updated UGemini, it is recommended to check out the [*releases page*](/~https://github.com/Uralstech/UGemini/releases) for information on breaking changes for each update. + ## Setup Add an instance of `Uralstech.UGemini.GeminiManager` to your scene, and set it up with your Gemini API key. You can get your API key from [*here*](https://makersuite.google.com/app/apikey). diff --git a/Documentation/DocSource/toc.yml b/Documentation/DocSource/toc.yml index 305a1b9..823885f 100644 --- a/Documentation/DocSource/toc.yml +++ b/Documentation/DocSource/toc.yml @@ -9,6 +9,4 @@ items: - name: GeminiChatRequest Features href: GeminiChatRequestFeatures.md - name: All Endpoints - href: AllEndpoints.md -- name: UGemini v2 Breaking Changes - href: BreakingChanges.md \ No newline at end of file + href: AllEndpoints.md \ No newline at end of file diff --git a/UGemini/Packages/com.uralstech.ugemini/Documentation~/APIReferenceManual.pdf b/UGemini/Packages/com.uralstech.ugemini/Documentation~/APIReferenceManual.pdf index 8ce73d4..ae4a494 100644 Binary files a/UGemini/Packages/com.uralstech.ugemini/Documentation~/APIReferenceManual.pdf and b/UGemini/Packages/com.uralstech.ugemini/Documentation~/APIReferenceManual.pdf differ diff --git a/UGemini/Packages/com.uralstech.ugemini/Documentation~/Documentation.pdf b/UGemini/Packages/com.uralstech.ugemini/Documentation~/Documentation.pdf index 5accd97..08c1a63 100644 Binary files a/UGemini/Packages/com.uralstech.ugemini/Documentation~/Documentation.pdf and b/UGemini/Packages/com.uralstech.ugemini/Documentation~/Documentation.pdf differ diff --git a/UGemini/Packages/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Documents/GeminiCorporaDocumentId.cs b/UGemini/Packages/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Documents/GeminiCorporaDocumentId.cs index 4aafac5..305d1c7 100644 --- a/UGemini/Packages/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Documents/GeminiCorporaDocumentId.cs +++ b/UGemini/Packages/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Documents/GeminiCorporaDocumentId.cs @@ -34,7 +34,7 @@ public GeminiCorpusDocumentId(string documentName) /// Creates a new . /// /// The resource ID of the Corpus which contains the Document. - /// The name (format 'corpora/{corpusId}/documents/{documentId}') or ID of the Document.The name (format 'corpora/{corpusId}/documents/{documentId}') or ID of the Document. public GeminiCorpusDocumentId(GeminiCorpusId corpusId, string documentNameOrId) { CorpusId = corpusId.ResourceId; diff --git a/UGemini/Packages/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Patch/GeminiCorporaPatchRequest.cs b/UGemini/Packages/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Patch/GeminiCorporaPatchRequest.cs index edd6b88..eff9926 100644 --- a/UGemini/Packages/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Patch/GeminiCorporaPatchRequest.cs +++ b/UGemini/Packages/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Patch/GeminiCorporaPatchRequest.cs @@ -47,7 +47,7 @@ public string GetEndpointUri(GeminiRequestMetadata metadata) } /// - /// Creates a new . + /// Creates a new . /// /// /// Only available in the beta API. diff --git a/UGemini/Packages/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Query/GeminiCorporaQueryResponse.cs b/UGemini/Packages/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Query/GeminiCorporaQueryResponse.cs index 624cd2e..493b863 100644 --- a/UGemini/Packages/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Query/GeminiCorporaQueryResponse.cs +++ b/UGemini/Packages/com.uralstech.ugemini/Runtime/Scripts/Data/Corpora/Query/GeminiCorporaQueryResponse.cs @@ -5,7 +5,7 @@ namespace Uralstech.UGemini.CorporaAPI { /// - /// The response for a or call. + /// The response for a call. /// [JsonObject(NamingStrategyType = typeof(CamelCaseNamingStrategy))] public class GeminiCorporaQueryResponse diff --git a/UGemini/Packages/com.uralstech.ugemini/package.json b/UGemini/Packages/com.uralstech.ugemini/package.json index 02b4038..e33b58b 100644 --- a/UGemini/Packages/com.uralstech.ugemini/package.json +++ b/UGemini/Packages/com.uralstech.ugemini/package.json @@ -9,7 +9,7 @@ "AI", "Integration" ], - "version": "2.3.0-preview.1", + "version": "2.3.0-preview.2", "unity": "2022.3", "hideInEditor": false, "documentationUrl": "https://uralstech.github.io/UGemini/",