You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/// Note: [Fine-tuned models](https://docs.cohere.com/docs/classify-fine-tuning) trained on classification examples don't require the `examples` parameter to be passed in explicitly.
523
523
/// </summary>
524
524
/// <param name="xClientName"></param>
525
+
/// <param name="examples">
526
+
/// An array of examples to provide context to the model. Each example is a text string and its associated label/class. Each unique label requires at least 2 examples associated with it; the maximum number of examples is 2500, and each example has a maximum length of 512 tokens. The values should be structured as `{text: "...",label: "..."}`.<br/>
527
+
/// Note: [Fine-tuned Models](https://docs.cohere.com/docs/classify-fine-tuning) trained on classification examples don't require the `examples` parameter to be passed in explicitly.<br/>
528
+
/// Included only in requests
529
+
/// </param>
525
530
/// <param name="inputs">
526
531
/// A list of up to 96 texts to be classified. Each one must be a non-empty string.<br/>
527
532
/// There is, however, no consistent, universal limit to the length a particular input can be. We perform classification on the first `x` tokens of each input, and `x` varies depending on which underlying model is powering classification. The maximum token length for each model is listed in the "max tokens" column [here](https://docs.cohere.com/docs/models).<br/>
528
533
/// Note: by default the `truncate` parameter is set to `END`, so tokens exceeding the limit will be automatically dropped. This behavior can be disabled by setting `truncate` to `NONE`, which will result in validation errors for longer texts.<br/>
529
534
/// Included only in requests
530
535
/// </param>
531
-
/// <param name="examples">
532
-
/// An array of examples to provide context to the model. Each example is a text string and its associated label/class. Each unique label requires at least 2 examples associated with it; the maximum number of examples is 2500, and each example has a maximum length of 512 tokens. The values should be structured as `{text: "...",label: "..."}`.<br/>
533
-
/// Note: [Fine-tuned Models](https://docs.cohere.com/docs/classify-fine-tuning) trained on classification examples don't require the `examples` parameter to be passed in explicitly.<br/>
534
-
/// Included only in requests
535
-
/// </param>
536
536
/// <param name="model">
537
-
/// The identifier of the model. Currently available models are `embed-multilingual-v2.0`, `embed-english-light-v2.0`, and `embed-english-v2.0` (default). Smaller "light" models are faster, while larger models will perform better. [Fine-tuned models](https://docs.cohere.com/docs/fine-tuning) can also be supplied with their full ID.<br/>
537
+
/// ID of a [Fine-tuned](https://docs.cohere.com/v2/docs/classify-starting-the-training) Classify model<br/>
/// This endpoint takes tokens using byte-pair encoding and returns their text representation. To learn more about tokenization and byte pair encoding, see the tokens page.
521
521
/// </summary>
522
522
/// <param name="xClientName"></param>
523
+
/// <param name="model">
524
+
/// An optional parameter to provide the model name. This will ensure that the detokenization is done by the tokenizer used by that model.
525
+
/// </param>
523
526
/// <param name="tokens">
524
527
/// The list of tokens to be detokenized.<br/>
525
528
/// Included only in requests
526
529
/// </param>
527
-
/// <param name="model">
528
-
/// An optional parameter to provide the model name. This will ensure that the detokenization is done by the tokenizer used by that model.
529
-
/// </param>
530
530
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// This endpoint returns text embeddings. An embedding is a list of floating point numbers that captures semantic information about the text that it represents.<br/>
30
-
/// Embeddings can be used to create text classifiers as well as empower semantic search. To learn more about embeddings, see the embedding page.<br/>
31
-
/// If you want to learn more how to use the embedding model, have a look at the [Semantic Search Guide](/docs/semantic-search).
28
+
/// Embed V1 API<br/>
29
+
/// This endpoint returns text and image embeddings. An embedding is a list of floating point numbers that captures semantic information about the content that it represents.<br/>
30
+
/// Embeddings can be used to create classifiers as well as empower semantic search. To learn more about embeddings, see the embedding page.<br/>
31
+
/// If you want to learn more how to use the embedding model, have a look at the [Semantic Search Guide](https://docs.cohere.com/docs/semantic-search).
32
32
/// </summary>
33
33
/// <param name="xClientName"></param>
34
34
/// <param name="request"></param>
35
35
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// This endpoint returns text embeddings. An embedding is a list of floating point numbers that captures semantic information about the text that it represents.<br/>
523
-
/// Embeddings can be used to create text classifiers as well as empower semantic search. To learn more about embeddings, see the embedding page.<br/>
524
-
/// If you want to learn more how to use the embedding model, have a look at the [Semantic Search Guide](/docs/semantic-search).
521
+
/// Embed V1 API<br/>
522
+
/// This endpoint returns text and image embeddings. An embedding is a list of floating point numbers that captures semantic information about the content that it represents.<br/>
523
+
/// Embeddings can be used to create classifiers as well as empower semantic search. To learn more about embeddings, see the embedding page.<br/>
524
+
/// If you want to learn more how to use the embedding model, have a look at the [Semantic Search Guide](https://docs.cohere.com/docs/semantic-search).
525
525
/// </summary>
526
526
/// <param name="xClientName"></param>
527
-
/// <param name="texts">
528
-
/// An array of strings for the model to embed. Maximum number of texts per call is `96`. We recommend reducing the length of each text to be under `512` tokens for optimal quality.<br/>
527
+
/// <param name="embeddingTypes">
528
+
/// Specifies the types of embeddings you want to get back. Not required and default is None, which returns the Embed Floats response type. Can be one or more of the following types.<br/>
529
+
/// * `"float"`: Use this when you want to get back the default float embeddings. Supported with all Embed models.<br/>
530
+
/// * `"int8"`: Use this when you want to get back signed int8 embeddings. Supported with Embed v3.0 and newer Embed models.<br/>
531
+
/// * `"uint8"`: Use this when you want to get back unsigned int8 embeddings. Supported with Embed v3.0 and newer Embed models.<br/>
532
+
/// * `"binary"`: Use this when you want to get back signed binary embeddings. Supported with Embed v3.0 and newer Embed models.<br/>
533
+
/// * `"ubinary"`: Use this when you want to get back unsigned binary embeddings. Supported with Embed v3.0 and newer Embed models.<br/>
529
534
/// Included only in requests
530
535
/// </param>
531
-
/// <param name="model">
532
-
/// Defaults to embed-english-v2.0<br/>
533
-
/// The identifier of the model. Smaller "light" models are faster, while larger models will perform better. [Custom models](/docs/training-custom-models) can also be supplied with their full ID.<br/>
534
-
/// Available models and corresponding embedding dimensions:<br/>
535
-
/// * `embed-english-v3.0` 1024<br/>
536
-
/// * `embed-multilingual-v3.0` 1024<br/>
537
-
/// * `embed-english-light-v3.0` 384<br/>
538
-
/// * `embed-multilingual-light-v3.0` 384<br/>
539
-
/// * `embed-english-v2.0` 4096<br/>
540
-
/// * `embed-english-light-v2.0` 1024<br/>
541
-
/// * `embed-multilingual-v2.0` 768<br/>
542
-
/// Included only in requests
536
+
/// <param name="images">
537
+
/// An array of image data URIs for the model to embed. Maximum number of images per call is `1`.<br/>
538
+
/// The image must be a valid [data URI](https://developer.mozilla.org/en-US/docs/Web/URI/Schemes/data). The image must be in either `image/jpeg` or `image/png` format and has a maximum size of 5MB.<br/>
539
+
/// Images are only supported with Embed v3.0 and newer models.
543
540
/// </param>
544
541
/// <param name="inputType">
545
542
/// Specifies the type of input passed to the model. Required for embedding models v3 and higher.<br/>
/// - `"clustering"`: Used for the embeddings run through a clustering algorithm.<br/>
550
547
/// - `"image"`: Used for embeddings with image input.
551
548
/// </param>
552
-
/// <param name="embeddingTypes">
553
-
/// Specifies the types of embeddings you want to get back. Not required and default is None, which returns the Embed Floats response type. Can be one or more of the following types.<br/>
554
-
/// * `"float"`: Use this when you want to get back the default float embeddings. Valid for all models.<br/>
555
-
/// * `"int8"`: Use this when you want to get back signed int8 embeddings. Valid for only v3 models.<br/>
556
-
/// * `"uint8"`: Use this when you want to get back unsigned int8 embeddings. Valid for only v3 models.<br/>
557
-
/// * `"binary"`: Use this when you want to get back signed binary embeddings. Valid for only v3 models.<br/>
558
-
/// * `"ubinary"`: Use this when you want to get back unsigned binary embeddings. Valid for only v3 models.<br/>
549
+
/// <param name="model">
550
+
/// ID of one of the available [Embedding models](https://docs.cohere.com/docs/cohere-embed).<br/>
551
+
/// Included only in requests
552
+
/// </param>
553
+
/// <param name="texts">
554
+
/// An array of strings for the model to embed. Maximum number of texts per call is `96`.<br/>
0 commit comments