feat:Add new endpoints and improve LangSmith API functionality and documentation #30
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
WalkthroughThe changes introduce new features and enhance existing functionalities within the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ChartsClient
participant API
participant ResponseHandler
User->>ChartsClient: ReadChartPreviewApiV1ChartsPreviewPostAsync(request)
ChartsClient->>API: POST /api/v1/charts/preview
API->>ChartsClient: Chart preview response
ChartsClient->>ResponseHandler: Process response
ResponseHandler-->>User: Return chart preview
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
coderabbitai
bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (10)
src/libs/LangSmith/Generated/LangSmith.Models.CustomChartCreatePreview.g.cs (3)
6-8: Add a class summary.The class lacks a summary description. Consider adding a brief explanation of the class's purpose.
/// <summary> -/// +/// Represents a preview of a custom chart creation. /// </summary>
11-13: Add a property summary forSeries.The
Seriesproperty lacks a summary description. Consider adding a brief explanation of what this property represents./// <summary> -/// +/// Gets or sets the series data for the custom chart. /// </summary>
18-20: Add a property summary forAdditionalProperties.The
AdditionalPropertiesproperty lacks a summary description. Consider adding a brief explanation of what this property represents./// <summary> -/// Additional properties that are not explicitly defined in the schema +/// Gets or sets additional properties that are not explicitly defined in the schema. /// </summary>src/libs/LangSmith/Generated/LangSmith.Models.SingleCustomChartResponseBase.g.cs (3)
6-8: Add a class summary.The class lacks a summary description. Consider adding a brief explanation of the class's purpose.
/// <summary> -/// +/// Represents the base response for a single custom chart. /// </summary>
11-13: Add a property summary forData.The
Dataproperty lacks a summary description. Consider adding a brief explanation of what this property represents./// <summary> -/// +/// Gets or sets the data points for the custom chart. /// </summary>
18-20: Add a property summary forAdditionalProperties.The
AdditionalPropertiesproperty lacks a summary description. Consider adding a brief explanation of what this property represents./// <summary> -/// Additional properties that are not explicitly defined in the schema +/// Gets or sets additional properties that are not explicitly defined in the schema. /// </summary>src/libs/LangSmith/Generated/LangSmith.Models.CustomChartPreviewRequest.g.cs (4)
6-8: Add a class summary.The class lacks a summary description. Consider adding a brief explanation of the class's purpose.
/// <summary> -/// +/// Represents a request for a custom chart preview. /// </summary>
11-13: Add a property summary forBucketInfo.The
BucketInfoproperty lacks a summary description. Consider adding a brief explanation of what this property represents./// <summary> -/// +/// Gets or sets the bucket information for the custom chart request. /// </summary>
18-20: Add a property summary forChart.The
Chartproperty lacks a summary description. Consider adding a brief explanation of what this property represents./// <summary> -/// +/// Gets or sets the chart details for the custom chart preview. /// </summary>
25-27: Add a property summary forAdditionalProperties.The
AdditionalPropertiesproperty lacks a summary description. Consider adding a brief explanation of what this property represents./// <summary> -/// Additional properties that are not explicitly defined in the schema +/// Gets or sets additional properties that are not explicitly defined in the schema. /// </summary>
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (10)
- src/libs/LangSmith/Generated/LangSmith.ChartsClient.ReadChartPreviewApiV1ChartsPreviewPost.g.cs (1 hunks)
- src/libs/LangSmith/Generated/LangSmith.LangSmithApi.OkApiV1OkGet.g.cs (5 hunks)
- src/libs/LangSmith/Generated/LangSmith.Models.CustomChartCreatePreview.g.cs (1 hunks)
- src/libs/LangSmith/Generated/LangSmith.Models.CustomChartPreviewRequest.g.cs (1 hunks)
- src/libs/LangSmith/Generated/LangSmith.Models.CustomChartsRequestBase.g.cs (1 hunks)
- src/libs/LangSmith/Generated/LangSmith.Models.OkApiV1OkGetResponse.g.cs (1 hunks)
- src/libs/LangSmith/Generated/LangSmith.Models.SingleCustomChartResponse.g.cs (2 hunks)
- src/libs/LangSmith/Generated/LangSmith.Models.SingleCustomChartResponseBase.g.cs (1 hunks)
- src/libs/LangSmith/Generated/LangSmith.RunClient.QueryRunsApiV1RunsQueryPost.g.cs (2 hunks)
- src/libs/LangSmith/openapi.yaml (9 hunks)
Files skipped from review due to trivial changes (2)
- src/libs/LangSmith/Generated/LangSmith.Models.OkApiV1OkGetResponse.g.cs
- src/libs/LangSmith/Generated/LangSmith.RunClient.QueryRunsApiV1RunsQueryPost.g.cs
Additional context used
GitHub Check: Test / Build, test and publish
src/libs/LangSmith/Generated/LangSmith.ChartsClient.ReadChartPreviewApiV1ChartsPreviewPost.g.cs
[failure] 94-94:
'SourceGenerationContext' does not contain a definition for 'NullableSingleCustomChartResponseBase' and no accessible extension method 'NullableSingleCustomChartResponseBase' accepting a first argument of type 'SourceGenerationContext' could be found (are you missing a using directive or an assembly reference?)
[failure] 94-94:
'SourceGenerationContext' does not contain a definition for 'NullableSingleCustomChartResponseBase' and no accessible extension method 'NullableSingleCustomChartResponseBase' accepting a first argument of type 'SourceGenerationContext' could be found (are you missing a using directive or an assembly reference?)
[failure] 94-94:
'SourceGenerationContext' does not contain a definition for 'NullableSingleCustomChartResponseBase' and no accessible extension method 'NullableSingleCustomChartResponseBase' accepting a first argument of type 'SourceGenerationContext' could be found (are you missing a using directive or an assembly reference?)
[failure] 94-94:
'SourceGenerationContext' does not contain a definition for 'NullableSingleCustomChartResponseBase' and no accessible extension method 'NullableSingleCustomChartResponseBase' accepting a first argument of type 'SourceGenerationContext' could be found (are you missing a using directive or an assembly reference?)
[failure] 94-94:
'SourceGenerationContext' does not contain a definition for 'NullableSingleCustomChartResponseBase' and no accessible extension method 'NullableSingleCustomChartResponseBase' accepting a first argument of type 'SourceGenerationContext' could be found (are you missing a using directive or an assembly reference?)
Additional comments not posted (22)
src/libs/LangSmith/Generated/LangSmith.Models.CustomChartsRequestBase.g.cs (5)
16-17: LGTM!The
Timezoneproperty is well-defined with a default value of "UTC".
22-24: LGTM!The
StartTimeproperty is correctly marked as required.
29-31: LGTM!The
EndTimeproperty is well-defined with a custom converter to handle multiple types.
36-38: LGTM!The
Strideproperty is correctly defined with a custom converter for complex types.
43-44: LGTM!The
AdditionalPropertiesproperty is correctly defined to handle extra data.src/libs/LangSmith/Generated/LangSmith.Models.SingleCustomChartResponse.g.cs (1)
16-18: LGTM!The
Dataproperty is correctly marked as required and uses appropriate JSON serialization attributes.src/libs/LangSmith/Generated/LangSmith.LangSmithApi.OkApiV1OkGet.g.cs (5)
8-9: LGTM!The method
PrepareOkApiV1OkGetArgumentsis correctly renamed to align with the new API versioning scheme.
10-12: LGTM!The method
PrepareOkApiV1OkGetRequestis correctly renamed to align with the new API versioning scheme.
13-15: LGTM!The method
ProcessOkApiV1OkGetResponseis correctly renamed to align with the new API versioning scheme.
17-19: LGTM!The method
ProcessOkApiV1OkGetResponseContentis correctly renamed to align with the new API versioning scheme.
Line range hint
27-79: LGTM!The method
OkApiV1OkGetAsyncis correctly renamed and updated to align with the new API versioning scheme and endpoint structure.src/libs/LangSmith/Generated/LangSmith.ChartsClient.ReadChartPreviewApiV1ChartsPreviewPost.g.cs (2)
84-91: LGTM! Error handling logic is appropriate.The error handling for unsuccessful HTTP responses is well-implemented using
EnsureSuccessStatusCodeand catchingHttpRequestException.
106-120: LGTM! Method implementation is correct.The method correctly constructs a
CustomChartPreviewRequestand calls the other overload.src/libs/LangSmith/openapi.yaml (9)
Line range hint
1-5: Verify the removal of the description for/api/v1/runs/query.The description for this endpoint has been removed. Ensure that this change is intentional and does not impact the understanding of the API's functionality.
7769-7798: LGTM! But verify the associated schemas for/api/v1/charts/preview.The addition of the
/api/v1/charts/previewendpoint is well-defined.Ensure that the
CustomChartPreviewRequestandSingleCustomChartResponseBaseschemas are correctly implemented and meet the expected requirements.
8002-8011: Approved: Addition of/api/v1/okendpoint.The
/api/v1/okendpoint is a useful addition for health checks and connectivity confirmation.
Line range hint
1-5: Approved: Security requirements.The security requirements are consistent and correctly applied.
10283-10293: LGTM! But verify theCustomChartSeriesschema forCustomChartCreatePreview.The
CustomChartCreatePreviewschema is well-defined.Ensure that the
CustomChartSeriesschema is correctly implemented and meets the expected requirements.
10316-10326: LGTM! But verify the referenced schemas forCustomChartPreviewRequest.The
CustomChartPreviewRequestschema is well-defined.Ensure that the
CustomChartsRequestBaseandCustomChartCreatePreviewschemas are correctly implemented and meet the expected requirements.
10583-10609: LGTM! But verify theTimedeltaInputschema forCustomChartsRequestBase.The
CustomChartsRequestBaseschema is well-defined.Ensure that the
TimedeltaInputschema is correctly implemented and meets the expected requirements.
16269-16281: LGTM! But verify theCustomChartsDataPointschema forSingleCustomChartResponse.The addition of the
dataproperty to theSingleCustomChartResponseschema is appropriate.Ensure that the
CustomChartsDataPointschema is correctly implemented and meets the expected requirements.
16309-16314: Approved: Addition ofSingleCustomChartResponseBaseschema.The
SingleCustomChartResponseBaseschema is well-defined and consistent with other response schemas.
| global::System.Text.Json.JsonSerializer.Deserialize(__content, global::LangSmith.SourceGenerationContext.Default.NullableSingleCustomChartResponseBase) ?? | ||
| throw new global::System.InvalidOperationException($"Response deserialization failed for \"{__content}\" "); |
There was a problem hiding this comment.
Fix the deserialization issue.
The SourceGenerationContext does not contain a definition for NullableSingleCustomChartResponseBase, which causes a build failure.
Ensure that NullableSingleCustomChartResponseBase is correctly defined or imported. If it's missing, consider adding it to SourceGenerationContext or replacing it with the correct type.
Tools
GitHub Check: Test / Build, test and publish
[failure] 94-94:
'SourceGenerationContext' does not contain a definition for 'NullableSingleCustomChartResponseBase' and no accessible extension method 'NullableSingleCustomChartResponseBase' accepting a first argument of type 'SourceGenerationContext' could be found (are you missing a using directive or an assembly reference?)
[failure] 94-94:
'SourceGenerationContext' does not contain a definition for 'NullableSingleCustomChartResponseBase' and no accessible extension method 'NullableSingleCustomChartResponseBase' accepting a first argument of type 'SourceGenerationContext' could be found (are you missing a using directive or an assembly reference?)
[failure] 94-94:
'SourceGenerationContext' does not contain a definition for 'NullableSingleCustomChartResponseBase' and no accessible extension method 'NullableSingleCustomChartResponseBase' accepting a first argument of type 'SourceGenerationContext' could be found (are you missing a using directive or an assembly reference?)
[failure] 94-94:
'SourceGenerationContext' does not contain a definition for 'NullableSingleCustomChartResponseBase' and no accessible extension method 'NullableSingleCustomChartResponseBase' accepting a first argument of type 'SourceGenerationContext' could be found (are you missing a using directive or an assembly reference?)
[failure] 94-94:
'SourceGenerationContext' does not contain a definition for 'NullableSingleCustomChartResponseBase' and no accessible extension method 'NullableSingleCustomChartResponseBase' accepting a first argument of type 'SourceGenerationContext' could be found (are you missing a using directive or an assembly reference?)
Summary by CodeRabbit
New Features
Bug Fixes
Documentation