🌿 Fern Regeneration -- April 13, 2025 (#45)

---------

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com>

Author: fern-api[bot]

.editorconfig

@@ -0,0 +1,35 @@
+root = true
+
+[*.cs]
+resharper_arrange_object_creation_when_type_evident_highlighting = hint
+resharper_auto_property_can_be_made_get_only_global_highlighting = hint
+resharper_check_namespace_highlighting = hint
+resharper_class_never_instantiated_global_highlighting = hint
+resharper_class_never_instantiated_local_highlighting = hint
+resharper_collection_never_updated_global_highlighting = hint
+resharper_convert_type_check_pattern_to_null_check_highlighting = hint
+resharper_inconsistent_naming_highlighting = hint
+resharper_member_can_be_private_global_highlighting = hint
+resharper_member_hides_static_from_outer_class_highlighting = hint
+resharper_not_accessed_field_local_highlighting = hint
+resharper_nullable_warning_suppression_is_used_highlighting = suggestion
+resharper_partial_type_with_single_part_highlighting = hint
+resharper_prefer_concrete_value_over_default_highlighting = none
+resharper_private_field_can_be_converted_to_local_variable_highlighting = hint
+resharper_property_can_be_made_init_only_global_highlighting = hint
+resharper_property_can_be_made_init_only_local_highlighting = hint
+resharper_redundant_name_qualifier_highlighting = none
+resharper_redundant_using_directive_highlighting = hint
+resharper_replace_slice_with_range_indexer_highlighting = none
+resharper_unused_auto_property_accessor_global_highlighting = hint
+resharper_unused_auto_property_accessor_local_highlighting = hint
+resharper_unused_member_global_highlighting = hint
+resharper_unused_type_global_highlighting = hint
+resharper_use_string_interpolation_highlighting = hint
+dotnet_diagnostic.CS1591.severity = suggestion
+
+[src/**/Types/*.cs]
+resharper_check_namespace_highlighting = none
+
+[src/**/Core/Public/*.cs]
+resharper_check_namespace_highlighting = none

.fernignore

@@ -1,14 +1,18 @@
 # Specify files that shouldn't be modified by Fern
 
 src/Pinecone/PineconeClient.cs
+src/Pinecone/Core/NdJsonRequest.cs
+src/Pinecone/Core/NdJsonContent.cs
 src/Pinecone/Core/Public/SourceTagOption.cs
 src/Pinecone/Core/Public/IsTlsEnabledOption.cs
 src/Pinecone/Types/Embedding.cs
+src/Pinecone/Index/IndexClientExtended.cs
 src/Pinecone.Test/Integration
 src/Pinecone.Test/Unit/EmbeddingTest.cs
 src/Pinecone.Test/Unit/AdditionalPropertiesTest.cs
 src/Pinecone.Test/Unit/UserAgentTest.cs
 src/Pinecone.Test/Unit/UnexpectedErrorTest.cs
+src/Pinecone.Test/Unit/NdJsonContentTest.cs
 src/Pinecone.Test/Unit/MockServer/EmbedTest.cs
 .github/workflows/ci.yml
 CONTRIBUTING.md

.mock/definition/__package__.yml

@@ -23,7 +23,7 @@ errors:
         name: Internal server error
   BadRequestError:
     status-code: 400
-    type: ErrorResponse
+    type: unknown
     docs: Bad request. The request body included invalid request parameters.
     examples:
       - value:
@@ -1738,69 +1738,42 @@ types:
       next: optional<string>
     source:
       proto: ../vector-service/proto/pinecone/data/v1/vector_service.proto
-  SearchRecordsRequestQuery:
-    docs: The query inputs to search with.
+  UpsertRecord:
+    docs: The request for the `upsert` operation.
     properties:
-      top_k:
-        type: integer
-        docs: The number of results to return for each search.
-      filter:
-        type: optional<map<string, unknown>>
-        docs: The filter to apply.
-      inputs: optional<EmbedInputs>
-      vector: optional<SearchRecordsVector>
-      id:
-        type: optional<string>
-        docs: The unique ID of the vector to be used as a query vector.
-        validation:
-          maxLength: 512
+      _id:
+        type: string
+        docs: The unique ID of the record to upsert.
+    extra-properties: true
     source:
       openapi: ../data-plane/openapi/openapi.yml
-    inline: true
-  SearchRecordsRequestRerank:
-    docs: Parameters for reranking the initial search results.
+  SearchRecordsResponseResult:
     properties:
-      model:
-        type: string
-        docs: >-
-          The name of the [reranking
-          model](https://docs.pinecone.io/guides/inference/understanding-inference#reranking-models)
-          to use.
-      rank_fields:
-        docs: The fields to use for reranking.
-        type: list<string>
-      top_n:
-        type: optional<integer>
-        docs: >-
-          The number of top results to return after reranking. Defaults to
-          top_k.
-      parameters:
-        type: optional<map<string, unknown>>
-        docs: >-
-          Additional model-specific parameters. Refer to the [model
-          guide](https://docs.pinecone.io/guides/inference/understanding-inference#reranking-models)
-          for available model parameters.
-      query:
-        type: optional<string>
-        docs: >-
-          The query to rerank documents against. If a specific rerank query is
-          specified,  it overwrites the query input that was provided at the top
-          level.
+      hits:
+        docs: The hits for the search document request.
+        type: list<Hit>
     source:
       openapi: ../data-plane/openapi/openapi.yml
     inline: true
-  SearchRecordsRequest:
-    docs: A search request for records in a specific namespace.
+  SearchRecordsResponse:
+    docs: The records search response.
+    properties:
+      result: SearchRecordsResponseResult
+      usage: SearchUsage
+    source:
+      openapi: ../data-plane/openapi/openapi.yml
+  Hit:
+    docs: A record whose vector values are similar to the provided search query.
     properties:
-      query:
-        type: SearchRecordsRequestQuery
-        docs: The query inputs to search with.
+      _id:
+        type: string
+        docs: The record id of the search hit.
+      _score:
+        type: float
+        docs: The similarity score of the returned record.
       fields:
-        type: optional<list<string>>
-        docs: The fields to return in the search results.
-      rerank:
-        type: optional<SearchRecordsRequestRerank>
-        docs: Parameters for reranking the initial search results.
+        type: map<string, unknown>
+        docs: The selected record fields associated with the search hit.
     source:
       openapi: ../data-plane/openapi/openapi.yml
   SearchUsage:
@@ -1842,6 +1815,7 @@ types:
         docs: The sparse embedding indices.
     source:
       openapi: ../data-plane/openapi/openapi.yml
+  SearchRequest: unknown
   Document:
     type: map<string, unknown>
     docs: Document for reranking
@@ -2010,6 +1984,19 @@ types:
         docs: The usage for this operation.
     source:
       proto: ../vector-service/proto/pinecone/data/v1/vector_service.proto
+  FieldBehavior:
+    enum:
+      - FIELD_BEHAVIOR_UNSPECIFIED
+      - OPTIONAL
+      - REQUIRED
+      - OUTPUT_ONLY
+      - INPUT_ONLY
+      - IMMUTABLE
+      - UNORDERED_LIST
+      - NON_EMPTY_DEFAULT
+      - IDENTIFIER
+    source:
+      proto: ../vector-service/proto/google/api/field_behavior.proto
   ListItem:
     properties:
       id: optional<string>

.mock/definition/api.yml

@@ -2,9 +2,9 @@ name: api
 error-discrimination:
   strategy: status-code
 display-name: Pinecone Control Plane API
-default-environment: Default
 environments:
   Default: https://api.pinecone.io
+default-environment: Default
 headers:
   X-Pinecone-API-Version:
     name: version

.mock/definition/index.yml

@@ -168,6 +168,63 @@ service:
             id: '101'
           response:
             body: {}
+    searchRecords:
+      path: /records/namespaces/{namespace}/search
+      method: POST
+      auth: true
+      docs: >-
+        This operation converts a query to a vector embedding and then searches
+        a namespace using the embedding. It returns the most similar records in
+        the namespace, along with their similarity scores.
+      source:
+        openapi: ../data-plane/openapi/openapi.yml
+      path-parameters:
+        namespace:
+          type: string
+          docs: The namespace to search.
+      display-name: Search a namespace
+      request:
+        name: SearchRecordsRequest
+        body:
+          properties:
+            query:
+              type: SearchRecordsRequestQuery
+              docs: The query inputs to search with.
+            fields:
+              type: optional<list<string>>
+              docs: The fields to return in the search results.
+            rerank:
+              type: optional<SearchRecordsRequestRerank>
+              docs: Parameters for reranking the initial search results.
+        content-type: application/json
+      response:
+        docs: A successful search namespace response.
+        type: root.SearchRecordsResponse
+        status-code: 200
+      errors:
+        - root.BadRequestError
+      examples:
+        - path-parameters:
+            namespace: namespace
+          request:
+            query:
+              top_k: 10
+              inputs:
+                text: your query text
+            fields:
+              - chunk_text
+          response:
+            body:
+              result:
+                hits:
+                  - _id: example-record-1
+                    _score: 0.9281134605407715
+                    fields:
+                      data: your example text
+              usage:
+                read_units: 5
+                embed_total_tokens: 10
+                rerank_units: 1
     describe_index_stats:
       path: /describe_index_stats
       method: POST
@@ -528,3 +585,55 @@ service:
               upsertedCount: 1
   source:
     proto: ../vector-service/proto/pinecone/data/v1/vector_service.proto
+types:
+  SearchRecordsRequestQuery:
+    docs: The query inputs to search with.
+    properties:
+      top_k:
+        type: integer
+        docs: The number of results to return for each search.
+      filter:
+        type: optional<map<string, unknown>>
+        docs: The filter to apply.
+      inputs: optional<root.EmbedInputs>
+      vector: optional<root.SearchRecordsVector>
+      id:
+        type: optional<string>
+        docs: The unique ID of the vector to be used as a query vector.
+        validation:
+          maxLength: 512
+    source:
+      openapi: ../data-plane/openapi/openapi.yml
+    inline: true
+  SearchRecordsRequestRerank:
+    docs: Parameters for reranking the initial search results.
+    properties:
+      model:
+        type: string
+        docs: >-
+          The name of the [reranking
+          model](https://docs.pinecone.io/guides/inference/understanding-inference#reranking-models)
+          to use.
+      rank_fields:
+        docs: The fields to use for reranking.
+        type: list<string>
+      top_n:
+        type: optional<integer>
+        docs: >-
+          The number of top results to return after reranking. Defaults to
+          top_k.
+      parameters:
+        type: optional<map<string, unknown>>
+        docs: >-
+          Additional model-specific parameters. Refer to the [model
+          guide](https://docs.pinecone.io/guides/inference/understanding-inference#reranking-models)
+          for available model parameters.
+      query:
+        type: optional<string>
+        docs: >-
+          The query to rerank documents against. If a specific rerank query is
+          specified,  it overwrites the query input that was provided at the top
+          level.
+    source:
+      openapi: ../data-plane/openapi/openapi.yml
+    inline: true

.mock/fern.config.json

@@ -1,4 +1,4 @@
 {
   "organization" : "pinecone",
-  "version" : "0.51.13"
+  "version" : "0.57.22"
 }